Installation

From source

To install from source, use:

pip install git+https://github.com/vandalt/nolito.git

For development

To install for development, first clone the repository locally and enter it:

git clone https://github.com/vandalt/nolito.git
cd nolito

Then install nolito in editable mode with the test and docs groups. This can be done with Pip:

python -m pip install -U -e . --group test --group docs

or with uv:

uv sync

The next subsections discuss how to perform various development tasks. If you installed with pip, simply remove uv run from the commands.

Building the documentation

You should then be able to build the docs with:

uv run make -C docs html

Running the unit tests

Nolito uses pytest for testing. Unit tests never call the API and only ensure that the information flow through Nolito is working as expected.

uv run pytest

Running the integration tests

Integration tests call the live Nolio API and are skipped by default. They require OAuth to be configured as described in Configuring the Nolio API. These tests are read-only and intentionally do not run in GitHub Actions.

To include integration tests when running pytest, explicitly add the --run-integration flag:

uv run pytest --run-integration

To run only the integration tests, either specify the path to tests/integration/ or add the -m integration flag.

To read more on how to set up and use nolito, see the Getting Started guide