============
aleph-client
============
Python Client for the aleph.im network, next generation network of decentralized big data applications.
Developement follows the `Aleph Whitepaper <https://github.com/aleph-im/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 <https://github.com/bitcoin-core/secp256k1>`_.
$ apt-get install -y python3-pip libsecp256k1-dev
- macOs :
$ brew tap cuber/homebrew-libsecp256k1
$ brew install libsecp256k1
Installation
============
Using pip and `PyPI <https://pypi.org/project/aleph-client/>`_:
$ 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/aleph-im/aleph-client",
"name": "aleph-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Aleph.im Team",
"author_email": "hello@aleph.im",
"download_url": "https://files.pythonhosted.org/packages/86/8d/d74e7f52cc19160883fc2d8b8e273f85413e9ebd94fbbcdb5a20d149cd53/aleph-client-0.6.0.tar.gz",
"platform": "any",
"description": "============\naleph-client\n============\n\nPython Client for the aleph.im network, next generation network of decentralized big data applications.\nDevelopement follows the `Aleph Whitepaper <https://github.com/aleph-im/aleph-whitepaper>`_.\n\nDocumentation\n=============\n\nDocumentation (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:\n\n $ python setup.py docs\n\n\nRequirements\n============\n\n- Linux : \n\nSome cryptographic functionalities use curve secp256k1 and require installing\n`libsecp256k1 <https://github.com/bitcoin-core/secp256k1>`_.\n\n $ apt-get install -y python3-pip libsecp256k1-dev\n\n- macOs : \n\n $ brew tap cuber/homebrew-libsecp256k1\n $ brew install libsecp256k1\n\n\nInstallation\n============\n\nUsing pip and `PyPI <https://pypi.org/project/aleph-client/>`_:\n\n $ pip install aleph-client\n\n\nInstallation for development\n============================\n\nIf you want NULS2 support you will need to install nuls2-python (currently only available on github):\n\n $ pip install git+https://github.com/aleph-im/nuls2-python.git\n\n\nTo install from source and still be able to modify the source code:\n\n $ pip install -e .\n or\n $ python setup.py develop\n\n\n\nUsing Docker\n============\n\nUse the Aleph client and it's CLI from within Docker or Podman with:\n\n\t\t$ docker run --rm -ti -v $(pwd)/data:/data ghcr.io/aleph-im/aleph-client/aleph-client:master --help\n\nWarning: This will use an ephemeral key that will be discarded when stopping the container.\n",
"bugtrack_url": null,
"license": "mit",
"summary": "Lightweight Python Client library for the Aleph.im network",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://aleph.im/",
"Homepage": "https://github.com/aleph-im/aleph-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0a617a13cc886a44f226f6dc315f2a39cd30aabdbc3ad327aba0190d2c1cc6d",
"md5": "05b559c411b99898472d143acd68f492",
"sha256": "b78063a7eaef146b9fd44aa351b5ad7c437e8332e54e8c852a94ceaffb8f186d"
},
"downloads": -1,
"filename": "aleph_client-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05b559c411b99898472d143acd68f492",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 30308,
"upload_time": "2023-12-15T15:42:48",
"upload_time_iso_8601": "2023-12-15T15:42:48.460925Z",
"url": "https://files.pythonhosted.org/packages/b0/a6/17a13cc886a44f226f6dc315f2a39cd30aabdbc3ad327aba0190d2c1cc6d/aleph_client-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "868dd74e7f52cc19160883fc2d8b8e273f85413e9ebd94fbbcdb5a20d149cd53",
"md5": "3b977411a2833593080e8c32ee015258",
"sha256": "6e1ab9da743694a4c60a0c17db2bef0d68ce11a6a51e492ecc28f600a4d0c8b9"
},
"downloads": -1,
"filename": "aleph-client-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "3b977411a2833593080e8c32ee015258",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43276,
"upload_time": "2023-12-15T15:42:50",
"upload_time_iso_8601": "2023-12-15T15:42:50.424233Z",
"url": "https://files.pythonhosted.org/packages/86/8d/d74e7f52cc19160883fc2d8b8e273f85413e9ebd94fbbcdb5a20d149cd53/aleph-client-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 15:42:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aleph-im",
"github_project": "aleph-client",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "aleph-client"
}
JSON
