Develop
As much as possible the configuration lives in pyproject.toml.
Installing from source
git clone https://github.com/14zombies/Rankade.py
cd rankade.py
pip3 install '.[dev]'
Available optional dependencies
To install run
$ pip3 install '.[all]'
- [dev]
Packages for building package.
- [docs]
Packages for building documentation.
- [tests]
Packages for running tests.
- [all]
All of the above.
Building docs
Docs built using Sphinx, MyST, & autodoc2, configuration for those lives in docs/conf.py.
git clone https://github.com/14zombies/Rankade.py
cd rankade.py
pip3 install '.[docs]'
make docs
Running tests
Tests built using unittest.
git clone https://github.com/14zombies/Rankade.py
cd rankade.py
pip3 install '.[tests]'
make tests
Generating Coverage Reports
git clone https://github.com/14zombies/Rankade.py
cd rankade.py
pip3 install '.[dev]'
make coverage