Installation

From the Python Package Index

To install delb manually, not as dependency, use pip:

$ pip install delb

At the moment there’s only one optional dependency to enable document loading via http and https, to include it use:

$ pip install delb[https-loader]

From source

Prerequisites:

• A virtual environment of your project is activated.

Obtain the code with roughly one of:

• git clone git@github.com:delb-xml/delb-py.git

• curl -LosS https://github.com/delb-xml/delb-py/archive/main.tar.gz | tar xzf -

To install it regularly:

…/delb-py $ pip install .

Again, to include the loading over http(s):

…/delb-py $ pip install .[https-loader]

For developing purposes of delb itself, the library should be installed in editable mode:

…/delb-py $ pip install --editable .

Hint

Using git submodules is a great way to vendorize a lib for your project and to have a fork for your adjustments. Please offer the latter to upstream if done well.

Developer toolbox

The repository includes configurations so that beside a suited Python interpreter two tools need to be available globally.

just

just is a task runner that executes a variety of common recipes. This gives a list of all available ones:

…/delb-py $ just --list

Before committing changes, run the complete suite of quality checks by invoking the default recipe:

…/delb-py $ just

Both, the recipes in the Justfile as well as various sections in the pyproject.toml, are prescriptive how different aspects are to be applied or tested.

pipx

pipx, often available from distributions’ repositories, is required to invoke various Python tools without explicitly installing them.

Development guidelines

pytest

You can skip some long running tests by invoking pytest in a context where the environment variable SKIP_LONG_RUNNING_TESTS is defined.