Skip to content

Commit f61e497

Browse files
fix: Update aleph.im & twentysix to aleph.cloud (#414)
Update broken doc links and references to old brand names (aleph.im, twentysix.cloud) to aleph.cloud
1 parent e64d162 commit f61e497

File tree

20 files changed

+148
-140
lines changed

20 files changed

+148
-140
lines changed

README.md

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
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
44
decentralized big data applications. Development follows the [Aleph
55
Whitepaper](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/
1515
Some cryptographic functionalities use curve secp256k1 and require
1616
installing [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

3337
Using 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

3945
Use 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

4351
Warning: This will use an ephemeral key pair that will be discarded when
4452
stopping the container
@@ -47,40 +55,56 @@ stopping the container
4755

4856
We 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.
5159
It 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

5971
or
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

7696
If 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

81103
To 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.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@
258258
# Grouping the document tree into LaTeX files. List of tuples
259259
# (source start file, target name, title, author, documentclass [howto/manual]).
260260
latex_documents = [
261-
("index", "user_guide.tex", "aleph-client Documentation", "Aleph.im", "manual"),
261+
("index", "user_guide.tex", "aleph-client Documentation", "Aleph Cloud", "manual"),
262262
]
263263

264264
# The name of an image file (relative to this directory) to place at the top of

docs/content/account.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Accounts
22
========
33

4-
To send data to the aleph.im network, you need to have an account.
4+
To send data to the Aleph Cloud network, you need to have an account.
55
This account can be made using any of the supported providers.
66

77
Common
@@ -111,4 +111,4 @@ From a private key:
111111
... bytes.fromhex(
112112
... "0000000000000000000000000000000000000000000000000000000000000001"))
113113
>>> account.get_address()
114-
'NULSd6Hgb53vAd7ZMoA2E17DUTT4C1nGrJVpn'
114+
'NULSd6Hgb53vAd7ZMoA2E17DUTT4C1nGrJVpn'

docs/content/async_notes.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Async vs Sync
33
=============
44

5-
At aleph.im we really like coding using asyncio,
5+
At Aleph Cloud we really like coding using asyncio,
66
using async/await construct on Python 3.
77

88
That being said, we totally understand that you might not
@@ -15,7 +15,7 @@ calling the async code behind your back (sneaky!) so you might
1515
be careful if you are calling it in an environment where you
1616
already have an asyncio loop used.
1717

18-
Most chain specific code is synchronous, and core aleph.im interaction
18+
Most chain specific code is synchronous, and core Aleph Cloud interaction
1919
might by async.
2020

2121
Sync code have to be imported from :py:mod:`aleph_client.synchronous`,
@@ -44,5 +44,4 @@ Example:
4444
... "0x06DE0C46884EbFF46558Cd1a9e7DA6B1c3E9D0a8",
4545
... "profile", session=session)
4646
...
47-
{"bio": "tester", "name": "Moshe on Ethereum"}
48-
47+
{"bio": "tester", "name": "Moshe on Ethereum"}

docs/content/cli.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
Command-line Interface
55
========
66

7-
Aleph-client can be used as a command-line interface to some Aleph.im
7+
Aleph-client can be used as a command-line interface to some Aleph Cloud
88
functionalities.
99

1010
The following commands are available:
1111

1212
Post
1313
----
1414

15-
Post a message on Aleph.im.
15+
Post a message on Aleph Cloud.
1616

1717
The content must be JSON encoded and is obtained either from a file
1818
or from a user prompt.
@@ -21,7 +21,7 @@ or from a user prompt.
2121
2222
python3 -m aleph_client post [OPTIONS]
2323
24-
Post a message on Aleph.im.
24+
Post a message on Aleph Cloud.
2525
2626
Options:
2727
--path TEXT
@@ -35,13 +35,13 @@ or from a user prompt.
3535
Upload
3636
------
3737

38-
Upload and store a file on Aleph.im.
38+
Upload and store a file on Aleph Cloud.
3939

4040
.. code-block:: bash
4141
4242
python3 -m aleph_client upload [OPTIONS] PATH
4343
44-
Upload and store a file on Aleph.im.
44+
Upload and store a file on Aleph Cloud.
4545
4646
Arguments:
4747
PATH [required]
@@ -55,13 +55,13 @@ Upload and store a file on Aleph.im.
5555
Pin
5656
---
5757

58-
Persist a file from IPFS on Aleph.im.
58+
Persist a file from IPFS on Aleph Cloud.
5959

6060
.. code-block:: bash
6161
6262
python3 -m aleph_client pin [OPTIONS] HASH
6363
64-
Persist a file from IPFS on Aleph.im.
64+
Persist a file from IPFS on Aleph Cloud.
6565
6666
Arguments:
6767
HASH [required]
@@ -75,13 +75,13 @@ Persist a file from IPFS on Aleph.im.
7575
Program
7676
-------
7777

78-
Register a program to run on Aleph.im virtual machines from a zip archive.
78+
Register a program to run on Aleph Cloud virtual machines from a zip archive.
7979

8080
.. code-block:: bash
8181
8282
python3 -m aleph_client program [OPTIONS] PATH ENTRYPOINT
8383
84-
Register a program to run on Aleph.im virtual machines from a zip archive.
84+
Register a program to run on Aleph Cloud virtual machines from a zip archive.
8585
8686
Arguments:
8787
PATH [required]

docs/content/introduction.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Introduction to Aleph.im
1+
Introduction to Aleph Cloud
22
========================
33

4-
The Aleph.im network can be accessed from any API server.
4+
The Aleph Cloud network can be accessed from any API server.
55
To run one yourself, you will need to install
66
`PyAleph <https://github.com/aleph-im/PyAleph>`_.
77

@@ -17,7 +17,7 @@ data type).
1717
Data structures
1818
---------------
1919

20-
All data transferred over the aleph.im network are aleph messages.
20+
All data transferred over the Aleph Cloud network are aleph messages.
2121

2222
.. uml::
2323

@@ -56,8 +56,8 @@ Actual content sent by regular users can currently be of two types:
5656
- AGGREGATE: a key-value storage specific to an address
5757
- POST: unique data posts (unique data points, events
5858

59-
.. uml::
60-
59+
.. uml::
60+
6161
@startuml
6262
object Message {
6363
...

docs/content/programs.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Programs
55
========
66

7-
Programs are special entries that define code to run on Aleph.im virtual machines.
7+
Programs are special entries that define code to run on Aleph Cloud virtual machines.
88

9-
Aleph.im currently supports programs written in Python that follow the
9+
Aleph Cloud currently supports programs written in Python that follow the
1010
`ASGI interface <https://asgi.readthedocs.io/en/latest/introduction.html>`_.
1111

1212
In practice, the easiest approach is to use an
@@ -21,7 +21,7 @@ Creating a program
2121
Follow the `FastAPI Tutorial <https://fastapi.tiangolo.com/tutorial/>`_
2222
to create your first program and test it using uvicorn.
2323

24-
Running on Aleph.im
24+
Running on Aleph Cloud
2525
-------------------
2626

2727
Use the :ref:`cli` to upload your program.

0 commit comments

Comments
 (0)