| Name | aleph-client JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | Python Client library for the Aleph.im network |
| upload_time | 2024-11-04 17:08:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | The MIT License (MIT) Copyright (c) 2019 Aleph.im project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
aleph.im
client
library
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# aleph-client
Python Client for the [aleph.im network](https://www.aleph.im), next generation network of
decentralized big data applications. Development follows the [Aleph
Whitepaper](https://github.com/aleph-im/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](https://github.com/bitcoin-core/secp256k1).
> 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](https://pypi.org/project/aleph-client/):
> 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](https://hatch.pypa.io/) 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 .
## Updating the User Documentation
The user documentation for Aleph is maintained in the `aleph-docs` repository. When releasing a new version, it's
important to update the documentation as part of the release process.
### Steps for Updating Documentation
Documentation is generated using the `typer` command.
If you have the `aleph-docs` repository cloned as a sibling folder to your current directory, you can use the following
command to generate updated documentation:
```shell
./scripts/gendoc.py src/aleph_client/__main__.py docs --name aleph --title 'Aleph CLI Documentation' --output ../aleph-docs/docs/tools/aleph-client/usage.md
```
After generating the documentation, you may need to update the path for the private key, as this depends on the user
configuration. This can be fixed manually using the `sed` command. For example:
```shell
sed -i 's#/home/olivier/.aleph-im/private-keys/sol2.key#~/.aleph-im/private-keys/ethereum.key#' ../aleph-docs/docs/tools/aleph-client/usage.md
```
This command replaces any hardcoded private key paths with the correct configuration path (
`~/.aleph-im/private-keys/ethereum.key`).
Once the documentation is updated, open a Pull Request (PR) on the `aleph-docs` repository with your changes.
Raw data
{
"_id": null,
"home_page": null,
"name": "aleph-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Aleph.im, Client, Library, Python",
"author": null,
"author_email": "\"Aleph.im Team\" <hello@aleph.im>",
"download_url": "https://files.pythonhosted.org/packages/d7/50/d4bfc3e20ace0c1ada6cd25d2c9561e7b6aa17fcc3cdecf4c5acb2811a5c/aleph_client-1.3.0.tar.gz",
"platform": null,
"description": "# aleph-client\n\nPython Client for the [aleph.im network](https://www.aleph.im), next generation network of\ndecentralized big data applications. Development follows the [Aleph\nWhitepaper](https://github.com/aleph-im/aleph-whitepaper).\n\n## Documentation\n\nDocumentation can be found on https://docs.aleph.im/tools/aleph-client/\n\n## Requirements\n\n### Linux\n\nSome cryptographic functionalities use curve secp256k1 and require\ninstalling [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### Windows\n\nThe software is not tested on Windows, but should work using \nthe Windows Subsystem for Linux (WSL).\n\n## Installation\n\n### From PyPI\n\nUsing pip and [PyPI](https://pypi.org/project/aleph-client/):\n\n> pip install aleph-client\n\n### Using a container\n\nUse the Aleph client and it\\'s CLI from within Docker or Podman with:\n\n> 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 pair that will be discarded when\nstopping the container\n\n## Installation for development\n\nWe recommend using [hatch](https://hatch.pypa.io/) for development.\n\nHatch is a modern, extensible Python project manager. \nIt creates a virtual environment for each project and manages dependencies.\n\n> pip install hatch\n \n### Running tests\n\n> hatch test\n\nor\n\n> hatch run testing:cov\n\n### Formatting code\n\n> hatch run linting:format\n\n### Checking types\n\n> hatch run linting:typing\n\n## Publish to PyPI\n\n> hatch build\n> hatch upload\n\nIf you want NULS2 support you will need to install nuls2-python\n(currently only available on github):\n\n> pip install aleph-sdk-python[nuls2]\n\nTo install from source and still be able to modify the source code:\n\n> pip install -e .\n\n## Updating the User Documentation\n\nThe user documentation for Aleph is maintained in the `aleph-docs` repository. When releasing a new version, it's\nimportant to update the documentation as part of the release process.\n\n### Steps for Updating Documentation\n\nDocumentation is generated using the `typer` command.\n\nIf you have the `aleph-docs` repository cloned as a sibling folder to your current directory, you can use the following\ncommand to generate updated documentation:\n\n```shell\n./scripts/gendoc.py src/aleph_client/__main__.py docs --name aleph --title 'Aleph CLI Documentation' --output ../aleph-docs/docs/tools/aleph-client/usage.md\n```\n\nAfter generating the documentation, you may need to update the path for the private key, as this depends on the user\nconfiguration. This can be fixed manually using the `sed` command. For example:\n\n```shell\nsed -i 's#/home/olivier/.aleph-im/private-keys/sol2.key#~/.aleph-im/private-keys/ethereum.key#' ../aleph-docs/docs/tools/aleph-client/usage.md\n```\n\nThis command replaces any hardcoded private key paths with the correct configuration path (\n`~/.aleph-im/private-keys/ethereum.key`).\n\nOnce the documentation is updated, open a Pull Request (PR) on the `aleph-docs` repository with your changes.",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2019 Aleph.im project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python Client library for the Aleph.im network",
"version": "1.3.0",
"project_urls": {
"Discussions": "https://community.aleph.im/",
"Documentation": "https://docs.aleph.im/tools/aleph-client/",
"Issues": "https://github.com/aleph-im/aleph-client/issues",
"Source": "https://github.com/aleph-im/aleph-client"
},
"split_keywords": [
"aleph.im",
" client",
" library",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfc2861a1ba5ce6173870be9c2c3ff7707f4ce574fcec882f33880bb4508895a",
"md5": "a3de97ac4b4ed87188163f259ca4387a",
"sha256": "7d67d0eeadbefdedf64d45b63ff7839a865233deeff406089aca99edcf4ef7cf"
},
"downloads": -1,
"filename": "aleph_client-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3de97ac4b4ed87188163f259ca4387a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 52217,
"upload_time": "2024-11-04T17:08:44",
"upload_time_iso_8601": "2024-11-04T17:08:44.198444Z",
"url": "https://files.pythonhosted.org/packages/df/c2/861a1ba5ce6173870be9c2c3ff7707f4ce574fcec882f33880bb4508895a/aleph_client-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d750d4bfc3e20ace0c1ada6cd25d2c9561e7b6aa17fcc3cdecf4c5acb2811a5c",
"md5": "4ea561495bcaf933a781d5ad18841b80",
"sha256": "167a3ac135718f181b3e425d91f1be7248710898a4cda4244ef2ba831fed0c92"
},
"downloads": -1,
"filename": "aleph_client-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4ea561495bcaf933a781d5ad18841b80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 41628,
"upload_time": "2024-11-04T17:08:46",
"upload_time_iso_8601": "2024-11-04T17:08:46.196607Z",
"url": "https://files.pythonhosted.org/packages/d7/50/d4bfc3e20ace0c1ada6cd25d2c9561e7b6aa17fcc3cdecf4c5acb2811a5c/aleph_client-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 17:08:46",
"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"
}
