Python Client for the aleph.im network, next generation network of decentralized big data applications. Developement follows the Aleph Whitepaper.
Documentation can be found on https://docs.aleph.im/tools/aleph-client/
Some cryptographic functionalities use curve secp256k1 and require installing libsecp256k1.
apt-get install -y python3-pip libsecp256k1-dev
brew tap cuber/homebrew-libsecp256k1 brew install libsecp256k1
The software is not tested on Windows, but should work using the Windows Subsystem for Linux (WSL).
Using pip and PyPI:
pip install aleph-client
Use the Aleph client and it\'s CLI from within Docker or Podman with:
docker run --rm -ti -v $(pwd)/<data:/data> ghcr.io/aleph-im/aleph-client/aleph-client:master --help
Warning: This will use an ephemeral key pair that will be discarded when stopping the container
We recommend using hatch for development.
Hatch is a modern, extensible Python project manager. It creates a virtual environment for each project and manages dependencies.
pip install hatch
hatch test
or
hatch run testing:cov
hatch run linting:format
hatch run linting:typing
hatch build hatch upload
If you want NULS2 support you will need to install nuls2-python (currently only available on github):
pip install aleph-sdk-python[nuls2]
To install from source and still be able to modify the source code:
pip install -e .