Contributing

Contributions and feature requests are very welcome!

If you have time and want to fix: Please open issues with that you want to add or write to me in Telegram: @xnuinside or mail: xnuinside@gmail.com

Developer guide

Project use pre-commit hooks, so you need setup them

Just run:

pre-commit install

to install git hooks in your .git/ directory.

How to run integration tests

Run integrations test from tests/integration_tests/

cd test/integration_tests

When 2 possible ways.

First way.

pytest . --docker-compose=test-docker-compose.yml -v

# will build and run docker compose & execute the tests

Second way (reduce time in process of tests creating/debuggind)

docker-compose -f test-docker-compose.yml up --build

# build & run test cluster

# when in new terminal window:

pytest . --docker-compose=test-docker-compose.yml --docker-compose-no-build --use-running-containers -v