Use Hatch for Project Management

.github/workflows/build-wheels.yml

@@ -16,7 +16,7 @@ jobs:
  runs-on: ${{ matrix.os }}
 
  steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
 
  - name: Workaround github issue https:/actions/runner-images/issues/7192
  if: startsWith(matrix.os, 'ubuntu-')
@@ -29,7 +29,7 @@ jobs:
  python-version: 3.11
 
  - name: Cache dependencies
- uses: actions/cache@v3
+ uses: actions/cache@v4
  with:
  path: ~/.cache/pip
  key: ${{ runner.os }}-build-wheels-${{ hashFiles('setup.cfg', 'setup.py') }}

.github/workflows/code-quality.yml

@@ -11,41 +11,26 @@ jobs:
  runs-on: ubuntu-22.04
 
  steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4
 
  - name: Workaround github issue https:/actions/runner-images/issues/7192
  run: sudo echo RESET grub-efi/install_devices | sudo debconf-communicate grub-pc
 
+ - name: Install pip and hatch
+ run: |
+ sudo apt-get install -y python3-pip
+ pip3 install hatch
+
  - name: Cache dependencies
- uses: actions/cache@v3
+ uses: actions/cache@v4
  with:
  path: ~/.cache/pip
- key: ${{ runner.os }}-code-quality-${{ hashFiles('setup.cfg', 'setup.py') }}
+ key: ${{ runner.os }}-code-quality-${{ hashFiles('pyproject.toml') }}
  restore-keys: |
  ${{ runner.os }}-code-quality-
 
  - name: Install required system packages only for Ubuntu Linux
- run: |
- sudo apt-get update
- sudo apt-get -y upgrade
- sudo apt-get install -y libsecp256k1-dev
-
- - name: Install required Python packages
- run: |
- python3 -m pip install -e .[testing,ethereum]
-
- - name: Test with Black
- run: |
- black --check ./src/ ./tests/ ./examples/
-
- - name: Test with isort
- run: |
- isort --check-only ./src/ ./tests/ ./examples/
+ run: sudo apt-get install -y libsecp256k1-dev
 
- - name: Test with MyPy
- run: |
- mypy --config-file ./mypy.ini ./src/ ./tests/ ./examples/
-
- - name: Test with flake8
- run: |
- flake8 ./src/ ./tests/ ./examples/
+ - name: Run Hatch lint
+ run: hatch run lint:all

.github/workflows/pytest.yml

@@ -0,0 +1,33 @@
+name: Test/Coverage with Python
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ build:
+ strategy:
+ matrix:
+ python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
+ with:
+ python-version: ${{ matrix.python-version }}
+ - run: sudo apt-get install -y python3-pip libsecp256k1-dev
+ - run: python -m pip install --upgrade pip hatch
+ - run: hatch run test:run
+ if: matrix.python-version != '3.11'
+ - run: hatch run test:run-coverage-report
+ if: matrix.python-version == '3.11'
+ - uses: codecov/[email protected]
+ if: matrix.python-version == '3.11'
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+ slug: aleph-im/aleph-vm

AUTHORS.rst

@@ -5,3 +5,4 @@ Contributors
 * Henry Taieb <[email protected]>
 * Hugo Herter <[email protected]>
 * Moshe Malawach <[email protected]>
+* Mike Hukiewitz <[email protected]>

README.md

@@ -5,11 +5,9 @@ Python SDK for the Aleph.im network, next generation network of decentralized bi
 Development follows the [Aleph Whitepaper](https:/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:
+The latest documentation, albeit incomplete, is available at [https://docs.aleph.im/libraries/python-sdk/](https://docs.aleph.im/libraries/python-sdk/).
 
-```shell
-$ python setup.py docs
-```
+For the full documentation, please refer to the docstrings in the source code.
 
 ## Requirements
 ### Linux 
@@ -31,18 +29,64 @@ $ brew install libsecp256k1
 Using pip and [PyPI](https://pypi.org/project/aleph-sdk-python/):
 
 ```shell
-$ pip install aleph-sdk-python[ethereum,solana,tezos]
+$ pip install aleph-sdk-python
+```
+
+### Additional dependencies
+Some functionalities require additional dependencies. They can be installed like this:
+
+```shell
+$ pip install aleph-sdk-python[ethereum, dns]
 ```
 
+The following extra dependencies are available:
+- `ethereum` for Ethereum and Ethereum-compatible chains
+- `solana` for Solana accounts and signatures
+- `cosmos` for Substrate/Cosmos accounts and signatures
+- `nuls2` for NULS2 accounts and signatures
+- `polkadot` for Polkadot accounts and signatures
+- `ledger` for Ledger hardware wallet support, see [Usage with LedgerHQ hardware](#usage-with-ledgerhq-hardware)
+- `mqtt` for MQTT-related functionalities, see [examples/mqtt.py](examples/mqtt.py)
+- `docs` for building the documentation, see [Documentation](#documentation)
+- `dns` for DNS-related functionalities
+- `all` installs all extra dependencies
+
+
 ## Installation for development
-To install from source and still be able to modify the source code:
+Setup a virtual environment using [hatch](https://hatch.pypa.io/):
+```shell
+$ hatch shell
+```
+
+Then install the SDK from source with all extra dependencies:
 
 ```shell
-$ pip install -e .[testing]
+$ pip install -e .[all]
 ```
-or 
+
+### Running tests & Hatch scripts
+You can use the test env defined for hatch to run the tests:
+
+```shell
+$ hatch run test:run
+```
+
+See `hatch env show` for more information about all the environments and their scripts.
+
+### Generating the documentation [DEPRECATED]
+The documentation is built using [Sphinx](https://www.sphinx-doc.org/).
+
+To build the documentation, install the SDK with the `docs` extra dependencies:
+
+```shell
+$ pip install -e .[docs]
+```
+
+Then build the documentation:
+
 ```shell
-$ python setup.py develop
+$ cd docs
+$ make html
 ```
 
 ## Usage with LedgerHQ hardware