Development

PyLaia uses different tools during its development.

Linter

Code syntax is analyzed before submitting the code.

To run the linter tools suite you may use pre-commit.

pip install pre-commit
pre-commit run -a

Tests

Unit tests

Tests are executed using tox.

pip install .[test]
tox

Documentation

This documentation uses Asciidoc and was generated using Antora.

Setup

Install docs dependencies :

npm install

Build the documentation using make antora. You can then write in Asciidoc in the relevant docs/*.adoc files. To see the doc site, you can run a small python web server in the public directory.

cd public
python3 -m http.server