Dialect map core

About

This repository contains core models and controllers for the database.

It is used as a dependency package on the HTTP API components that manage public and private access to the database information. The public API is used by the Dialect map UI, while the private one by a set of data-ingestion jobs which populate the database.

Documentation

For more information about the interaction with this repository:

• Database setup.
• Models definitions.

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.