Contributions are welcome!
To run the tests, you just need to run tox. Everything must be green before patches get merged.
We use black to format our code. Please apply black on your patches before submiting them.
python3 setup.py compile_catalog cd demo ./run.sh # or `docker-compose up` to run it with docker
Then you have access to:
A canaille server at http://localhost:5000
A dummy client at http://localhost:5001
Another dummy client at http://localhost:5002
The canaille server has some default users:
A regular user which login and password are user;
A moderator user which login and password are moderator;
An admin user which admin and password are admin.
The documentation is generated when the tests run:
The generated documentation is in ./build/sphinx/html/ directory.