# aleph-sdk-python
Python SDK for the Aleph.im network, next generation network of decentralized big data applications.
Development 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-sdk-python.readthedocs.io/](http://aleph-sdk-python.readthedocs.io/) or built from this repo with:
```shell
$ python setup.py docs
```
## Requirements
### Linux
Some cryptographic functionalities use curve secp256k1 and require installing [libsecp256k1](https://github.com/bitcoin-core/secp256k1).
```shell
$ 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.
```shell
$ brew tap cuber/homebrew-libsecp256k1
$ brew install libsecp256k1
```
## Installation
Using pip and [PyPI](https://pypi.org/project/aleph-sdk-python/):
```shell
$ pip install aleph-sdk-python[ethereum,solana,tezos]
```
## Installation for development
To install from source and still be able to modify the source code:
```shell
$ pip install -e .[testing]
```
or
```shell
$ python setup.py develop
```
## Usage with LedgerHQ hardware
The SDK supports signatures using [app-ethereum](https://github.com/LedgerHQ/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](https://packages.debian.org/bookworm/ledger-wallets-udev).
`sudo apt-get install ledger-wallets-udev`
### On NixOS
Configure `hardware.ledger.enable = true`.
### Other Linux systems
See https://github.com/LedgerHQ/udev-rules
Raw data
{
"_id": null,
"home_page": "https://github.com/aleph-im/aleph-sdk-python",
"name": "aleph-sdk-python",
"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/a2/04/b69602623149e42deb10f0eb3c745a08d8e98bb2b426327ec386611f4e61/aleph-sdk-python-0.9.1.tar.gz",
"platform": "any",
"description": "\n# aleph-sdk-python\nPython SDK for the Aleph.im network, next generation network of decentralized big data applications.\n\nDevelopment follows the [Aleph Whitepaper](https://github.com/aleph-im/aleph-whitepaper).\n\n## Documentation\nDocumentation (albeit still vastly incomplete as it is a work in progress) can be found at [http://aleph-sdk-python.readthedocs.io/](http://aleph-sdk-python.readthedocs.io/) or built from this repo with:\n\n```shell\n$ python setup.py docs\n```\n\n## Requirements\n### Linux \nSome cryptographic functionalities use curve secp256k1 and require installing [libsecp256k1](https://github.com/bitcoin-core/secp256k1).\n\n```shell\n$ apt-get install -y python3-pip libsecp256k1-dev\n```\nUsing some chains may also require installing `libgmp3-dev`.\n\n### macOs\nThis project does not support Python 3.12 on macOS. Please use Python 3.11 instead.\n```shell\n$ brew tap cuber/homebrew-libsecp256k1\n$ brew install libsecp256k1\n```\n\n## Installation\nUsing pip and [PyPI](https://pypi.org/project/aleph-sdk-python/):\n\n```shell\n$ pip install aleph-sdk-python[ethereum,solana,tezos]\n```\n\n## Installation for development\nTo install from source and still be able to modify the source code:\n\n```shell\n$ pip install -e .[testing]\n```\nor \n```shell\n$ python setup.py develop\n```\n\n## Usage with LedgerHQ hardware\n\nThe SDK supports signatures using [app-ethereum](https://github.com/LedgerHQ/app-ethereum),\nthe Ethereum app for the Ledger hardware wallets.\n\nThis has been tested successfully on Linux (amd64).\nLet us know if it works for you on other operating systems.\n\nUsing a Ledger device on Linux requires root access or the setup of udev rules.\n\nUnlocking the device is required before using the relevant SDK functions.\n\n### Debian / Ubuntu\n\nInstall [ledger-wallets-udev](https://packages.debian.org/bookworm/ledger-wallets-udev).\n\n`sudo apt-get install ledger-wallets-udev`\n\n### On NixOS\n\nConfigure `hardware.ledger.enable = true`.\n\n### Other Linux systems\n\nSee https://github.com/LedgerHQ/udev-rules\n\n\n",
"bugtrack_url": null,
"license": "mit",
"summary": "Lightweight Python Client library for the Aleph.im network",
"version": "0.9.1",
"project_urls": {
"Documentation": "https://aleph.im/",
"Homepage": "https://github.com/aleph-im/aleph-sdk-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "891b3822abbb57ced76df566c0f6eaee7fda949aa9c86f7d9e04d83a2656ea4c",
"md5": "f566ccf6e1b7404b86d9fc860e7a6528",
"sha256": "05759b05b0f53441f64a5b034ece73550164d307d739dd000dd12252dd65290e"
},
"downloads": -1,
"filename": "aleph_sdk_python-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f566ccf6e1b7404b86d9fc860e7a6528",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 54894,
"upload_time": "2024-03-13T11:46:28",
"upload_time_iso_8601": "2024-03-13T11:46:28.345830Z",
"url": "https://files.pythonhosted.org/packages/89/1b/3822abbb57ced76df566c0f6eaee7fda949aa9c86f7d9e04d83a2656ea4c/aleph_sdk_python-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a204b69602623149e42deb10f0eb3c745a08d8e98bb2b426327ec386611f4e61",
"md5": "94f66e5564fb76f262e9ce01578ee3fe",
"sha256": "76d1a0e6023c990ac475fbe18283fc3e4f58717139feb05a3d18984c25088fab"
},
"downloads": -1,
"filename": "aleph-sdk-python-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "94f66e5564fb76f262e9ce01578ee3fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 79883,
"upload_time": "2024-03-13T11:46:46",
"upload_time_iso_8601": "2024-03-13T11:46:46.838151Z",
"url": "https://files.pythonhosted.org/packages/a2/04/b69602623149e42deb10f0eb3c745a08d8e98bb2b426327ec386611f4e61/aleph-sdk-python-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 11:46:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aleph-im",
"github_project": "aleph-sdk-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "aleph-sdk-python"
}
JSON
