Lumigator SDK

The SDK provides the communication and validation primitives needed to contact the Lumigator itself, either locally or remotely.

You can install the lumigator SDK via pip directly or via uv from the cloned repository:

pip install -e lumigator/sdk

or

uv pip install -e lumigator/sdk

Now that you have the SDK installed, you can use it to communicate with Lumigator. You can run the example notebook for a platform API walkthrough, or follow the quickstart guide in the documentation.

The SDK uses the lumigator-schemas package models, but with stricter validations, so properties not explicitly defined in the schemas will be handled as errors.

Test instructions

The SDK includes both unit tests (requiring no additional containers) and integration tests (requiring a live Lumigator backend). By default only unit tests are run.

To run unit tests, please use:

uv run pytest

To run integration tests, please use:

pushd ../../../../ # go back to the project root
make start-lumigator-build # wait until all containers are up and running
popd
uv run pytest -o python_files="int_test_*.py" # wait until all tests have passed; update and repeat...
pushd ../../../../ # go back to the project root
make local-down # wait until all containers are removed
popd

The tests include a unit test suite and an integration test suite. There are make targets available at the root folder, as follows:

• sdk-test: runs sdk-unit-test and sdk-int-test
  • sdk-unit-test: runs tests in backend/tests/unit/*/test_*.py (any depth of subfolders)
  • sdk-int-test: runs tests in backend/tests/int/*/test_*.py (any depth of subfolders)

A live Lumigator backend is started for integration tests.