CONTRIBUTING.md

Contributing

This project is hosted on GitHub.

Visit GitHub{: .md-button .md-button--primary }

Scripts

We provide a Makefile which helps the developers to:

• run tests,
• build the documentation (Database structure and Processing algorithms)
• generate the SQL files used for installing the structure in a PostgreSQL database.

Translation

The UI is available on Transifex, no development knowledge is required.

Code

SQL and Python are covered by unittests with Docker.

pip install -r requirements-dev.txt
flake8
make tests
make test_migration

On a new database, if you want to install the database by using migrations :

import os
os.environ['TEST_DATABASE_INSTALL_LIZSYNC'] = '0.2.2'  # Enable
del os.environ['TEST_DATABASE_INSTALL_LIZSYNC']  # Disable

Documentation

The documentation is using MkDocs with Material :

pip install -r requirements-doc.txt
mkdocs serve

• Processing algorithms documentation can be generated with:

make processing-doc

• PostgreSQL database structure with SchemaSpy

make schemaspy