Skip to content

Commit f9c0c7e

Browse files
hohhoh
authored
Fix: Rename aleph-client -> aleph-sdk-python (#8)
* Fix: Rename aleph-client -> aleph-sdk-python * Fix: README was not displayed on PyPI * CI: Importing aleph.sdk after installation
1 parent 779cb3a commit f9c0c7e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+118
-169
lines changed

‎.github/workflows/build-wheels.yml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,11 @@ jobs:
3737
3838
- name: Install the Python wheel
3939
run: |
40-
python3 -m pip install dist/aleph_client-*.whl
40+
python3 -m pip install dist/aleph_sdk_python-*.whl
41+
42+
- name: Import and use the package
43+
# macos tests fail this step because they use Python 3.11, which is not yet supported by our dependencies
44+
if: startsWith(matrix.os, 'ubuntu-')
45+
run: |
46+
python3 -c "import aleph.sdk"
47+
python3 -c "from aleph.sdk.chains.ethereum import get_fallback_account; get_fallback_account()"

‎.github/workflows/pytest-docker.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ jobs:
1717

1818
# Use GitHub's Docker registry to cache intermediate layers
1919
- run: echo ${{ secrets.GITHUB_TOKEN }} | docker login docker.pkg.github.com -u $GITHUB_ACTOR --password-stdin
20-
- run: docker pull docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-client-build-cache || true
20+
- run: docker pull docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-sdk-python-build-cache || true
2121

2222
- name: Build the Docker image
2323
run: |
2424
git fetch --prune --unshallow --tags
25-
docker build . -t aleph-client:${GITHUB_REF##*/} -f docker/${{matrix.image}}.dockerfile --cache-from=docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-client-build-cache
25+
docker build . -t aleph-sdk-python:${GITHUB_REF##*/} -f docker/${{matrix.image}}.dockerfile --cache-from=docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-sdk-python-build-cache
2626
2727
- name: Push the image on GitHub's repository
28-
run: docker tag aleph-client:${GITHUB_REF##*/} docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-client:${GITHUB_REF##*/} && docker push docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-client:${GITHUB_REF##*/} || true
28+
run: docker tag aleph-sdk-python:${GITHUB_REF##*/} docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-sdk-python:${GITHUB_REF##*/} && docker push docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-sdk-python:${GITHUB_REF##*/} || true
2929

3030
- name: Cache the image on GitHub's repository
31-
run: docker tag aleph-client:${GITHUB_REF##*/} docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-client-build-cache && docker push docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-client-build-cache || true
31+
run: docker tag aleph-sdk-python:${GITHUB_REF##*/} docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-sdk-python-build-cache && docker push docker.pkg.github.com/$GITHUB_REPOSITORY/aleph-sdk-python-build-cache || true
3232

3333
- name: Pytest in the Docker image
3434
run: |
35-
docker run --entrypoint /opt/venv/bin/pytest aleph-client:${GITHUB_REF##*/} /opt/aleph-client/
35+
docker run --entrypoint /opt/venv/bin/pytest aleph-sdk-python:${GITHUB_REF##*/} /opt/aleph-sdk-python/

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Python SDK for the Aleph.im network, next generation network of decentralized bi
55
Development follows the [Aleph Whitepaper](https://github.com/aleph-im/aleph-whitepaper).
66

77
## Documentation
8-
Documentation (albeit still vastly incomplete as it is a work in progress) can be found at [http://aleph-client.readthedocs.io/](http://aleph-client.readthedocs.io/) or built from this repo with:
8+
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:
99

1010
```shell
1111
$ python setup.py docs

‎docker/python-3.10.dockerfile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y \
77

88
RUN useradd -s /bin/bash --create-home user
99
RUN mkdir /opt/venv
10-
RUN mkdir /opt/aleph-client/
10+
RUN mkdir /opt/aleph-sdk-python/
1111
RUN chown user:user /opt/venv
12-
RUN chown user:user /opt/aleph-client
12+
RUN chown user:user /opt/aleph-sdk-python
1313

1414
USER user
1515
RUN python3 -m venv /opt/venv
@@ -23,10 +23,10 @@ RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
2323
RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
2424
RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
2525

26-
WORKDIR /opt/aleph-client/
26+
WORKDIR /opt/aleph-sdk-python/
2727
COPY . .
2828
USER root
29-
RUN chown -R user:user /opt/aleph-client
29+
RUN chown -R user:user /opt/aleph-sdk-python
3030

3131
RUN pip install -e .[testing,ethereum,solana,tezos]
3232

‎docker/python-3.11.dockerfile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y \
77

88
RUN useradd -s /bin/bash --create-home user
99
RUN mkdir /opt/venv
10-
RUN mkdir /opt/aleph-client/
10+
RUN mkdir /opt/aleph-sdk-python/
1111
RUN chown user:user /opt/venv
12-
RUN chown user:user /opt/aleph-client
12+
RUN chown user:user /opt/aleph-sdk-python
1313

1414
USER user
1515
RUN python3 -m venv /opt/venv
@@ -23,10 +23,10 @@ RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
2323
RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
2424
RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
2525

26-
WORKDIR /opt/aleph-client/
26+
WORKDIR /opt/aleph-sdk-python/
2727
COPY . .
2828
USER root
29-
RUN chown -R user:user /opt/aleph-client
29+
RUN chown -R user:user /opt/aleph-sdk-python
3030

3131
RUN pip install -e .[testing,ethereum,solana,tezos]
3232

‎docker/python-3.9.dockerfile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y \
77

88
RUN useradd -s /bin/bash --create-home user
99
RUN mkdir /opt/venv
10-
RUN mkdir /opt/aleph-client/
10+
RUN mkdir /opt/aleph-sdk-python/
1111
RUN chown user:user /opt/venv
12-
RUN chown user:user /opt/aleph-client
12+
RUN chown user:user /opt/aleph-sdk-python
1313

1414
USER user
1515
RUN python3 -m venv /opt/venv
@@ -23,10 +23,10 @@ RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
2323
RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
2424
RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
2525

26-
WORKDIR /opt/aleph-client/
26+
WORKDIR /opt/aleph-sdk-python/
2727
COPY . .
2828
USER root
29-
RUN chown -R user:user /opt/aleph-client
29+
RUN chown -R user:user /opt/aleph-sdk-python
3030

3131
RUN pip install -e .[testing,ethereum,solana,tezos]
3232

‎docker/ubuntu-20.04.dockerfile‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y \
1212

1313
RUN useradd -s /bin/bash --create-home user
1414
RUN mkdir /opt/venv
15-
RUN mkdir /opt/aleph-client/
15+
RUN mkdir /opt/aleph-sdk-python/
1616
RUN chown user:user /opt/venv
17-
RUN chown user:user /opt/aleph-client
17+
RUN chown user:user /opt/aleph-sdk-python
1818

1919
USER user
2020
RUN python3 -m venv /opt/venv
@@ -28,12 +28,12 @@ RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
2828
RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
2929
RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
3030

31-
WORKDIR /opt/aleph-client/
31+
WORKDIR /opt/aleph-sdk-python/
3232
COPY . .
3333
USER root
34-
RUN chown -R user:user /opt/aleph-client
34+
RUN chown -R user:user /opt/aleph-sdk-python
3535

36-
RUN git config --global --add safe.directory /opt/aleph-client
36+
RUN git config --global --add safe.directory /opt/aleph-sdk-python
3737
RUN pip install -e .[testing,ethereum,solana,tezos]
3838

3939
RUN mkdir /data

‎docker/ubuntu-22.04.dockerfile‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y \
1212

1313
RUN useradd -s /bin/bash --create-home user
1414
RUN mkdir /opt/venv
15-
RUN mkdir /opt/aleph-client/
15+
RUN mkdir /opt/aleph-sdk-python/
1616
RUN chown user:user /opt/venv
17-
RUN chown user:user /opt/aleph-client
17+
RUN chown user:user /opt/aleph-sdk-python
1818

1919
USER user
2020
RUN python3 -m venv /opt/venv
@@ -28,12 +28,12 @@ RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
2828
RUN pip install --upgrade 'aleph-message~=0.3.0' eth_account pynacl base58
2929
RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
3030

31-
WORKDIR /opt/aleph-client/
31+
WORKDIR /opt/aleph-sdk-python/
3232
COPY . .
3333
USER root
34-
RUN chown -R user:user /opt/aleph-client
34+
RUN chown -R user:user /opt/aleph-sdk-python
3535

36-
RUN git config --global --add safe.directory /opt/aleph-client
36+
RUN git config --global --add safe.directory /opt/aleph-sdk-python
3737
RUN pip install -e .[testing,ethereum,solana,tezos]
3838

3939
RUN mkdir /data

‎docker/with-ipfs.dockerfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y \
2525
libsecp256k1-dev \
2626
&& rm -rf /var/lib/apt/lists/*
2727

28-
RUN mkdir /opt/aleph-client/
29-
WORKDIR /opt/aleph-client/
28+
RUN mkdir /opt/aleph-sdk-python/
29+
WORKDIR /opt/aleph-sdk-python/
3030
COPY . .
3131

3232
RUN pip install -e .[testing,ethereum]

‎docs/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ PAPER =
88
BUILDDIR = ../build/sphinx/
99
AUTODOCDIR = api
1010
AUTODOCBUILD = sphinx-apidoc
11-
PROJECT = aleph-client
11+
PROJECT = aleph-sdk-python
1212
MODULEDIR = ../src/aleph_client
1313

1414
# User-friendly check for sphinx-build

0 commit comments

Comments
 (0)