Requirements

The main colourettu module, has the following dependencies:

    "pillow >= 8.3.2",

Testing

Testing colourettu requires:

green >=1.9.4  # v2 works
coverage
isort >= 5
pydocstyle
pycodestyle
check-manifest
black

For unit test, then run (from the base directory):

green colourettu.tests -vv

For code-style test, then run (from the base directory):

isort colourettu setup.py tasks.py --verbose
black colourettu
pydocstyle colourettu
pycodestyle colourettu

Note

Code-style tests remain aspirational at this point, and so failures here are permitted.

Before packaging, check the manifest (Manifest.in) by running (from the base directory):

check-manifest -v

Documentation Generation

To generation the documentation (this) for colourettu, colourettu itself must be installed (it is imported in the process of building the documentation). The following dependencies are also required:

sphinx >= 4.2
cloud_sptheme >= 1.8.0
releases
Babel >=1.3,!=2.0
ghp-import == 0.5.4
PSphinxTheme @ git+https://github.com/MinchinWeb/PSphinxTheme.git@colourettu#egg=PSphinxTheme
python-lconf-lexer @ git+https://github.com/MinchinWeb/python_lconf_lexer.git@colourettu#egg=python-lconf-lexer

# sub-dependencies, minimums for security reasons
Pygments >= 2.7.4
Jinja2 >= 2.11.3
requests >= 2.20.0
six  # needed by releases

Then run (on Windows) (from the docs directory):

make html

To upload the documention, then run (still from the docs directory):

ghp-import -p _build/html