Installation

Install

pip install pyboltzmann

uv add pyboltzmann

import boltzmann

The distribution is pyboltzmann; the import package is boltzmann. boltzmann on PyPI belongs to an unrelated package, so publishing under it is not available. It is the same split as pygaussia providing gaussia.

Requirements

Python 3.11, 3.12 or 3.13
The core needs only pydantic and rfc8785

Extras

The core needs no extra. The on-disk brain is already an OCI layout, so packing an artifact and moving it between layouts works with the standard library alone.

Extra	Adds	For
`oci`	`oras`	Publishing to and installing from a network OCI registry
`conformance`	`pytest`	Inheriting the behavioural conformance suites, which are pytest classes

The golden vectors need neither extra. They are plain JSON in the wheel, so from boltzmann.conformance import golden works on a bare install — which is the point, since the caller they exist for writes their client in another language.

pip install 'pyboltzmann[oci]'

uv add 'pyboltzmann[oci]'

Index engines and exposure layers ship no extra at all — they are the implementation’s choice.

Verify the install

import boltzmann
from boltzmann import Brain, BrainReader

print(boltzmann.__version__)
print(boltzmann.PROTOCOL_VERSION)
assert isinstance(Brain, type) and issubclass(Brain, object)

Every interface is runtime_checkable, so conformance is asserted rather than hoped for:

from boltzmann import BrainReader

assert isinstance(my_client, BrainReader)

Development install

git clone https://github.com/gaussia-labs/pyboltzmann.git
cd pyboltzmann
uv sync
uv run pre-commit install && uv run pre-commit install --hook-type commit-msg

uv run ruff check . && uv run ruff format .
uv run mypy src/boltzmann
uv run pytest

Commits follow Conventional Commits — use uv run cz commit for the interactive prompt. Releases are cut by python-semantic-release from the commit history.

Getting started

Core concepts

Guides

Install

Requirements

Extras

Verify the install

Development install

​Install

​Requirements

​Extras

​Verify the install

​Development install

Install

Requirements

Extras

Verify the install

Development install