Table of Contents
SchemaVer is a python package and command line tool to help users manage the Schema Version of JSON schemas and OpenAPI schema objects.
- poetry - Dependency management library that makes creating and installing packages more streamlined.
- pytest - Simplifies the design and execution of both unit and integration testing.
- black - Autoformats code for consistent styling.
- ruff - Lints and formats code.
- pylint - Checks that code follows idiomatic best practices for Python.
- pre-commit - Runs code quality checks before code is committed.
- Python installed on your local machine, a version 3.11 or greater
- Poetry installed on your local machine
In order to check that you have both Python and Poetry installed, run the following in your command line, and the output should look something like this:
NOTE: in all of the code blocks below, lines preceded with $ indicate commands you should enter in your command line (excluding the $ itself), while lines preceded with > indicate the expected output from the previous command.
$ python --version && poetry --version
> Python 3.9.0
> Poetry version 1.1.6
TROUBLESHOOTING: If you receive an error message, or the version of python you have installed is not between 3.7 and 3.9, consider using a tool like pyenv (on Mac/Linux) or pyenv-win (on Windows) to manage multiple python installations.
If you have python installed but not poetry, follow these installation instructions:
- Global install on Mac/Linux
- Global install on Windows
- Local install inside a virtual environment using
pipNOTE: This is not recommended because of potential package conflicts:- Create a virtual environment:
python -m venv env - Acvitate the virtual environment. NOTE: This virtual environment must be active any time you are working with this project:
- Mac/Linux:
source env/bin/activate - Windows:
env\Scripts\activate
- Mac/Linux:
- Install poetry:
pip install poetry
- Create a virtual environment:
- Clone the repository on your local machine
- Change directory into the cloned project:
cd schemaver - Set up the project:
make setup
TODO
The vision for this package and CLI tool is to simplify the process of managing migrations between JSON schemas to ensure that a schema repository is versioned using the SchemaVer format proposed by Snowplow
- Adopting a common python package file structure
- Implementing basic linting and code quality checks
- Reinforcing compliance with those code quality checks using CI/CD
- Providing templates for things like documentation, issues, and pull requests
- Offering pythonic implementation examples of common data structures and scripting tasks like:
- Creating classes, methods, and functions
- Setting up unit and integration testing
- Reading and writing to files
For a more detailed breakdown of the feature roadmap and other development priorities please reference the following links:
Contributions are always welcome! We encourage contributions in the form of discussion on issues in this repo and pull requests for improvements to documentation and code.
See CONTRIBUTING.md for ways to get started.
Distributed under the MIT License. See LICENSE for more information.