Skip to content

Installation

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

  • calimero_client_py — the client: Client, its generated methods (documented in using the client and the method reference) and the compiled extension (calimero_client_py._native) they send through.
  • calimero — a thin Python package that re-exports the same names.

Its Python dependencies are httpx and attrs, which pip installs with it.

  • Python 3.9 or newer (CPython).

PyPI carries one prebuilt wheel per platform, built against Python’s stable ABI (abi3), so it installs on every CPython from 3.9 on without compiling:

Platform Wheel
Linux x86_64 manylinux2014_x86_64 (glibc 2.17+)
Linux aarch64 manylinux2014_aarch64 (glibc 2.17+)
macOS Apple silicon macosx_11_0_arm64
macOS Intel macosx_10_12_x86_64
Windows x86_64 win_amd64
Terminal window
pip install calimero-client-py

This installs the latest release (1.0.0 or later), the client for Calimero 1.0’s node. The client for v1’s node is 0.9.0 (pip install calimero-client-py==0.9.0).

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

That prints the installed version.

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:

    Terminal window
    git clone https://github.com/calimero-network/calimero-client-py.git
    cd calimero-client-py
  2. Install maturin and build in development mode:

    Terminal window
    pip install maturin
    maturin develop --release
  3. Confirm the import works:

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