Dialect map schemas

About

This repository contains the data schemas shared across the different components.

Data schemas are logical abstractions wrapping database data model definitions that are use by different software components to either serialize or deserialize certain attributes of those models (or the models in their entirety).

Documentation

For more information about data schemas and their relationship to the core package defined data models:

• Data schemas.

Dependencies

Python dependencies are specified within the pyproject.toml file.

In order to install the development packages, as long as the defined commit hooks:

pip install ".[all]"
pre-commit install

Formatting

All Python files are formatted using Black, and the custom properties defined in the pyproject.toml file.

make check

Testing

Project testing is performed using Pytest. In order to run the tests:

make test

Tagging

Commits can be tagged to create informal releases of the package. In order to do so:

1. Bump up the package version (VERSION) following Semantic Versioning.
2. Add a new section to the CHANGELOG.
3. Create and push a tag: make tag.