Python Client library for the Aleph.im network
Project description
aleph-client
Python Client for the aleph.im network, next generation network of decentralized big data applications. Developement follows the Aleph Whitepaper.
Documentation
Documentation can be found on https://docs.aleph.im/tools/aleph-client/
Requirements
Linux
Some cryptographic functionalities use curve secp256k1 and require installing libsecp256k1.
apt-get install -y python3-pip libsecp256k1-dev
macOs
brew tap cuber/homebrew-libsecp256k1 brew install libsecp256k1
Windows
The software is not tested on Windows, but should work using the Windows Subsystem for Linux (WSL).
Installation
From PyPI
Using pip and PyPI:
pip install aleph-client
Using a container
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
Installation for development
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
Running tests
hatch test
or
hatch run testing:cov
Formatting code
hatch run linting:format
Checking types
hatch run linting:typing
Publish to PyPI
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 .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aleph_client-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 427e7db6b9614b679f4c1e85552d3b8c69d5b482f2c7381175008a222db1bba0 |
|
MD5 | ab7080af931f33edd442662cc7ee5260 |
|
BLAKE2b-256 | 03c24d9dd1c5e0c8ebf4ecd4b11e698eca3f4cdec03ca27c92d455c14823a038 |