Installation and setup

valjean uses poetry for packaging and dependency management; follow the instructions on the poetry home page to install this tool.

If you plan to develop valjean and you have checked out the source repository, you may want to use poetry to install the package in “development mode” instead:

$ python3 -m venv ~/venv-valjean-dev
$ source ~/venv-valjean-dev/bin/activate
(venv-valjean-dev) $ cd /path/to/valjean-X.Y.Z
(venv-valjean-dev) $ poetry install -E dev

This will install valjean and all of its dependencies in your current virtual environment. The development dependencies (e.g. sphinx, pytest, etc.) will also be installed; if you want to skip them, omit the -E dev flag to poetry install.

This procedure should install just a link to your source folder /path/to/valjean-X.Y.Z, instead of copying the source files to the installation directory. This way, you will not need to reinstall the package every time you modify the sources.

Dependency management

Dependencies are managed by poetry. We ship a poetry lock file to guarantee that valjean will not be broken by future package updates. This also means that developers should think about updating the package constraints in pyproject.toml and regenerating the lock file from time to time.

See the poetry documentation for more information about adding or upgrading dependencies.