Everything you should know when working on this project.

Installing Dependencies

Container Env uses Poetry for dependency management. If you do not have it installed, download it from PyPI:

$ pip install poetry

Using Poetry, install the development dependencies:

$ poetry install

Testing, Linting and Formatting

Run the unit tests check coverate:

$ coverage run --branch --omit tests* --module pytest

Show the coverage report:

$ coverage report

Lint the sources:

$ pylint container_env tests
$ flake8

Format the sources:

$ black container_env tests

Documentation

Container Env uses Hugo to build the documentation. The CD pipeline uses version 0.73.0. It is not managed through Poetry and needs to be installed manually.

Start a hot reload server on localhost:1313/container-env:

$ hugo serve --source docs

Build the documentation to dist/docs:

$ hugo --source docs --destination ../dist/docs