Development

Qwen 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 with tox using pytest.

pip install tox
tox

To recreate tox virtual environment (e.g. a dependencies update), you may run tox -r.

Run a single test module: tox -- <test_path>

Run a single test: tox -- <test_path>::<test_function>

Documentation

This documentation uses Asciidoc and was generated using Antora.

Setup

Install the needed dependencies through:

npm config set @doc:registry=https://gitlab.teklia.com/api/v4/groups/676/-/packages/npm/
npm i

Build the documentation using make antora. Run a server using python -m http.server inside the ./public directory. You can then write in Asciidoc in the relevant docs/*.adoc files, and see output on http://localhost:8000.