aleph-sdk-python
Python SDK for the Aleph.im network, next generation network of decentralized big data applications.
Development follows the Aleph Whitepaper.
Documentation
The latest documentation, albeit incomplete, is available at https://docs.aleph.im/libraries/python-sdk/.
For the full documentation, please refer to the docstrings in the source code.
Requirements
Linux
Some cryptographic functionalities use curve secp256k1 and require installing libsecp256k1.
$ apt-get install -y python3-pip libsecp256k1-dev
Using some chains may also require installing libgmp3-dev.
macOs
This project does not support Python 3.12 on macOS. Please use Python 3.11 instead.
$ brew install secp256k1
Installation
Using pip and PyPI:
$ pip install aleph-sdk-python
Additional dependencies
Some functionalities require additional dependencies. They can be installed like this:
$ pip install aleph-sdk-python[solana, dns]
The following extra dependencies are available:
solanafor Solana accounts and signaturescosmosfor Substrate/Cosmos accounts and signaturesnuls2for NULS2 accounts and signaturespolkadotfor Polkadot accounts and signaturesledgerfor Ledger hardware wallet support, see Usage with LedgerHQ hardwaremqttfor MQTT-related functionalities, see examples/mqtt.pydocsfor building the documentation, see Documentationdnsfor DNS-related functionalitiesallinstalls all extra dependencies
Installation for development
Setup a virtual environment using hatch:
$ hatch shell
Then install the SDK from source with all extra dependencies:
$ pip install -e .[all]
Running tests & Hatch scripts
You can use the test env defined for hatch to run the tests:
$ hatch run testing:run
See hatch env show for more information about all the environments and their scripts.
Generating the documentation [DEPRECATED]
The documentation is built using Sphinx.
To build the documentation, install the SDK with the docs extra dependencies:
$ pip install -e .[docs]
Then build the documentation:
$ cd docs
$ make html
Usage with LedgerHQ hardware
The SDK supports signatures using app-ethereum, the Ethereum app for the Ledger hardware wallets.
This has been tested successfully on Linux (amd64). Let us know if it works for you on other operating systems.
Using a Ledger device on Linux requires root access or the setup of udev rules.
Unlocking the device is required before using the relevant SDK functions.
Debian / Ubuntu
Install ledger-wallets-udev.
sudo apt-get install ledger-wallets-udev
On NixOS
Configure hardware.ledger.enable = true.
Other Linux systems
3 maintainers
Metadata
3 maintainers
Release files for aleph-sdk-python 2.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aleph_sdk_python-2.4.0.tar.gz | 76.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aleph_sdk_python-2.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 180.5 kB
Release files / aleph_sdk_python-2.4.0.tar.gz
| Download URL | aleph_sdk_python-2.4.0.tar.gz |
|---|---|
| Size | 76.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2a8e9cde1072adb32fc6f764dd14467f36269140f897521c7f08dcea8e5e5834
|
|
BLAKE2b-256 checksum How to use checksums |
0764e10f96da9b85d8ba274028a876db98143c508b61bc6ec42b46ce625bdda4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logRelease files / aleph_sdk_python-2.4.0-py3-none-any.whl
| Download URL | aleph_sdk_python-2.4.0-py3-none-any.whl |
|---|---|
| Size | 103.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33a1aba6b96e15bd053ce5fa0416d467009953d10ab7bd1ec7ff7b68adce18b7
|
|
BLAKE2b-256 checksum How to use checksums |
60ccc5ec77402ac5324b14f52b666c18604efb207cc6be934aba917fb9522a2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency log
