11# aleph-client
22
3- Python Client for the [ aleph.im network] ( https://www.aleph.im ) , next generation network of
3+ Python Client for the [ Aleph Cloud network] ( https://www.aleph.cloud ) , next generation network of
44decentralized big data applications. Development follows the [ Aleph
55Whitepaper] ( https://github.com/aleph-im/aleph-whitepaper ) .
66
77## Documentation
88
9- Documentation can be found on https://docs.aleph.im/ tools/aleph-client /
9+ Documentation can be found on https://docs.aleph.cloud/devhub/sdks-and- tools/aleph-cli /
1010
1111## Requirements
1212
@@ -15,12 +15,16 @@ Documentation can be found on https://docs.aleph.im/tools/aleph-client/
1515Some cryptographic functionalities use curve secp256k1 and require
1616installing [ libsecp256k1] ( https://github.com/bitcoin-core/secp256k1 ) .
1717
18- > apt-get install -y python3-pip libsecp256k1-dev squashfs-tools
18+ ``` sh
19+ apt-get install -y python3-pip libsecp256k1-dev squashfs-tools
20+ ```
1921
2022### macOs
2123
22- > brew tap cuber/homebrew-libsecp256k1
23- > brew install libsecp256k1
24+ ``` sh
25+ brew tap cuber/homebrew-libsecp256k1
26+ brew install libsecp256k1
27+ ```
2428
2529### Windows
2630
@@ -32,13 +36,17 @@ We recommend using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
3236
3337Using pip and [ PyPI] ( https://pypi.org/project/aleph-client/ ) :
3438
35- > pip install aleph-client
39+ ``` sh
40+ pip install aleph-client
41+ ```
3642
3743### Using a container
3844
3945Use the Aleph client and it\' s CLI from within Docker or Podman with:
4046
41- > docker run --rm -ti -v $(pwd)/< data:/data > ghcr.io/aleph-im/aleph-client/aleph-client: master --help
47+ ``` sh
48+ docker run --rm -ti -v $( pwd) /< data:/data> ghcr.io/aleph-im/aleph-client/aleph-client:master --help
49+ ```
4250
4351Warning: This will use an ephemeral key pair that will be discarded when
4452stopping the container
@@ -47,40 +55,56 @@ stopping the container
4755
4856We recommend using [ hatch] ( https://hatch.pypa.io/ ) for development.
4957
50- Hatch is a modern, extensible Python project manager.
58+ Hatch is a modern, extensible Python project manager.
5159It creates a virtual environment for each project and manages dependencies.
5260
53- > pip install hatch
54-
61+ ``` sh
62+ pip install hatch
63+ ```
64+
5565### Running tests
5666
57- > hatch test
67+ ``` sh
68+ hatch test
69+ ```
5870
5971or
6072
61- > hatch run testing: cov
73+ ``` sh
74+ hatch run testing:cov
75+ ```
6276
6377### Formatting code
6478
65- > hatch run linting: fmt
79+ ``` sh
80+ hatch run linting:fmt
81+ ```
6682
6783### Checking types
6884
69- > hatch run linting: typing
85+ ```
86+ hatch run linting:typing
87+ ```
7088
7189## Publish to PyPI
7290
73- > hatch build
74- > hatch upload
91+ ``` sh
92+ hatch build
93+ hatch upload
94+ ```
7595
7696If you want NULS2 support you will need to install nuls2-python
7797(currently only available on github):
7898
79- > pip install aleph-sdk-python[ nuls2]
99+ ```
100+ pip install aleph-sdk-python[nuls2]
101+ ```
80102
81103To install from source and still be able to modify the source code:
82104
83- > pip install -e .
105+ ``` sh
106+ pip install -e .
107+ ```
84108
85109## Updating the User Documentation
86110
@@ -95,4 +119,4 @@ command to generate updated documentation:
95119 --output ../aleph-docs/docs/tools/aleph-client/usage.md
96120```
97121
98- Then, open a Pull Request (PR) on the [ aleph-docs] ( https://github.com/aleph-im/aleph-docs/pulls ) repository with your changes.
122+ Then, open a Pull Request (PR) on the [ aleph-docs] ( https://github.com/aleph-im/aleph-docs/pulls ) repository with your changes.
0 commit comments