Installation

calimero-client-py is a Python client SDK backed by a native Rust core, built with PyO3 and maturin. Two importable modules are installed:

• calimero_client_py — the compiled extension: the classes and functions documented in the API reference.
• calimero — a thin Python package that re-exports the same names and provides the calimero-client-py CLI.

Requirements

• Python 3.9 or newer.
• A Rust toolchain (stable) and a working C compiler.

Installing compiles from source

The package is published to PyPI as a source distribution (sdist), not as prebuilt wheels. pip install therefore builds the Rust extension on your machine, which needs a Rust toolchain on PATH. Install one with rustup if you do not have cargo already:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install from PyPI

pip

pip install calimero-client-py

pipx

pipx install calimero-client-py

The build can take a few minutes the first time while Cargo compiles the Rust dependencies.

Verify

python -c "import calimero_client_py; print(calimero_client_py.VERSION)"

That prints the installed version. The CLI is also on your PATH:

calimero-client-py --version

Install from source

Clone the repository and build with maturin. maturin develop compiles the extension and installs it into the active virtual environment in one step.

1. Clone and enter the repository:

   git clone https://github.com/calimero-network/calimero-client-py.git
   cd calimero-client-py

2. Install maturin and build in development mode:

   pip install maturin
   maturin develop --release

3. Confirm the import works:

   python -c "import calimero_client_py; print('ok', calimero_client_py.VERSION)"

Note

The Rust core depends on Calimero crates pulled from github.com/calimero-network/core, so the first build fetches and compiles those too. A network connection is required for the initial build.

Next steps

QuickstartConnect to a node and make your first call.

Connecting to a nodeConnections, the node_name parameter, and creating a client.