Calimero Client Python Library
A Python client SDK for Calimero Network, backed by a native Rust core via PyO3. Connect to a node, manage applications and contexts, move blobs, administer namespaces and groups, and call your app's methods over JSON-RPC — all from synchronous Python.
Documentation
Full documentation is published at
https://calimero-network.github.io/calimero-client-py/ — installation,
quickstart, task guides, and the complete Python API reference. The source lives
under docs/.
Installation
pip install calimero-client-py
The package is published as a source distribution (no prebuilt wheels), so
installing compiles the native Rust extension on your machine. You need a Rust
toolchain on PATH — install one with rustup if you don't
already have cargo. Python 3.9+ is required. See the
installation guide
for details.
Quick start
Every Client method is synchronous: it blocks until the node responds and
returns a plain Python value (a dict, list, bytes, or scalar). There are no
coroutines and nothing to await.
from calimero_client_py import create_connection, create_client
connection = create_connection(
api_url="http://localhost:2428",
node_name="local-dev", # stable name; used for the token cache
)
client = create_client(connection)
print("connected to", client.get_api_url())
contexts = client.list_contexts()
print(f"found {len(contexts)} contexts")
# call a method on the app running in a context (args is a JSON string)
result = client.execute_function(
context_id="<context-id>",
method="set",
args='{"key": "greeting", "value": "hello"}',
)
print(result)
See the quickstart and guides for connecting, authentication, contexts, blobs, and namespaces & groups.
CLI
Installing the package puts a small calimero-client-py command on your PATH
for quick checks:
calimero-client-py --version
calimero-client-py --base-url http://localhost:2428 list-contexts
See the CLI reference.
Development
Build from source with maturin:
pip install maturin
maturin develop --release # compile the extension into the active venv
python -c "import calimero_client_py; print('ok', calimero_client_py.VERSION)"
Run the tests:
cargo test # Rust unit tests
pytest # Python tests
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).
Support
- Documentation: https://calimero-network.github.io/calimero-client-py/
- Issues: https://github.com/calimero-network/calimero-client-py/issues
- Contact: team@calimero.network
License
See LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file calimero_client_py-0.6.27.tar.gz.
File metadata
- Download URL: calimero_client_py-0.6.27.tar.gz
- Upload date:
- Size: 54.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
adcc3a58ffe968d5a795572d937c459b6e2ab927088549634c3bbe3a3bc2de32
|
|
| MD5 |
7a7413fe35403b66004c4ea598156cd8
|
|
| BLAKE2b-256 |
a567b6f87436903584e95cd7a6425a7589ff3138c4b799e9a8563911db13b055
|
Provenance
The following attestation bundles were made for calimero_client_py-0.6.27.tar.gz:
Publisher:
build-wheels.yml on calimero-network/calimero-client-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
calimero_client_py-0.6.27.tar.gz -
Subject digest:
adcc3a58ffe968d5a795572d937c459b6e2ab927088549634c3bbe3a3bc2de32 - Sigstore transparency entry: 2477615767
- Sigstore integration time:
-
Permalink:
calimero-network/calimero-client-py@fdb4371826e2e655ecb87a7faa79e020b5df3c16 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/calimero-network
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build-wheels.yml@fdb4371826e2e655ecb87a7faa79e020b5df3c16 -
Trigger Event:
push
-
Statement type:
