Skip to content

Lightweight Python Client library for the Aleph.im network

License

Notifications You must be signed in to change notification settings

funttastic/aleph-client

 
 

Repository files navigation

aleph-client

Python Client for the aleph.im network, next generation network of decentralized big data applications. Developement follows the Aleph Whitepaper.

Documentation

Documentation (albeit still vastly incomplete as it is a work in progress) can be found at http://aleph-client.readthedocs.io/ or built from this repo with:

$ python setup.py docs

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

Installation

Using pip and PyPI:

$ pip install aleph-client

Installation for development

If you want NULS2 support you will need to install nuls2-python (currently only available on github):

$ pip install git+https://github.com/aleph-im/nuls2-python.git

To install from source and still be able to modify the source code:

$ pip install -e . or $ python setup.py develop

Using Docker

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 that will be discarded when stopping the container.

About

Lightweight Python Client library for the Aleph.im network

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 96.3%
  • Dockerfile 2.2%
  • Shell 1.5%