Refactor: instance list to handle PAYG instance

.github/workflows/code-quality.yml

@@ -0,0 +1,36 @@
+name: Test code quality
+
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  code-quality:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Workaround github issue https://github.com/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 hatch-vcs
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          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 install -y libsecp256k1-dev
+
+      - name: Run Hatch lint
+        run: hatch run linting:all

.github/workflows/pytest.yml

@@ -0,0 +1,51 @@
+name: Pytest and code Coverage
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - main
+  schedule:
+    # Run every night at 04:00 (GitHub Actions timezone)
+    # in order to catch when unfrozen dependency updates
+    # break the use of the library.
+    - cron: '4 0 * * *'
+
+jobs:
+  pytest:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ macos-12, macos-13, macos-14, ubuntu-20.04, ubuntu-22.04, ubuntu-24.04 ]
+    runs-on: ${{matrix.os}}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install required system packages for macOS
+        run: sudo apt-get install -y python3-pip libsecp256k1-dev
+        if: startsWith(matrix.os, 'ubuntu-')
+
+      - name: Install required system packages for macOS
+        if: startsWith(matrix.os, 'macos-')
+        run: |
+          brew update
+          brew tap cuber/homebrew-libsecp256k1
+          brew install libsecp256k1
+          brew install automake
+
+      - run: python3 -m venv /tmp/venv
+      - run: /tmp/venv/bin/python -m pip install --upgrade pip hatch coverage
+
+        # Only run coverage on one OS
+      - run: /tmp/venv/bin/hatch run testing:test
+        if: matrix.os != 'ubuntu-24.04'
+      - run: /tmp/venv/bin/hatch run testing:cov
+        if: matrix.os == 'ubuntu-24.04'
+      - uses: codecov/[email protected]
+        if: matrix.os == 'ubuntu-24.04'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: aleph-im/aleph-sdk-python

.github/workflows/test-build.yml

@@ -9,10 +9,11 @@ on:
       - master
 
 jobs:
-  build: 
-    strategy: 
+  build-install-wheel:
+    strategy:
+      fail-fast: false
       matrix:
-        os: [macos-11, macos-12, ubuntu-20.04, ubuntu-22.04]
+        os: [macos-12, macos-13, macos-14, ubuntu-20.04, ubuntu-22.04, ubuntu-24.04]
     runs-on: ${{matrix.os}}
 
     steps:
@@ -35,23 +36,23 @@ jobs:
         with:
           python-version: 3.11
 
-
       - name: Install required system packages only for Ubuntu Linux
         if: startsWith(matrix.os, 'ubuntu-')
         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 --upgrade build
-          python3 -m pip install --user --upgrade twine
+          python3 -m venv /tmp/venv
+          /tmp/venv/bin/python3 -m pip install --upgrade hatch hatch-vcs
 
       - name: Build source and wheel packages
         run: |
-          python3 -m build
+          /tmp/venv/bin/hatch build
 
       - name: Install the Python wheel
         run: |
-          python3 -m pip install dist/aleph_client-*.whl
+          python3 -m venv /tmp/install-venv
+          /tmp/install-venv/bin/python3 -m pip install dist/aleph_client-*.whl

.github/workflows/test-pytest.yml → .github/workflows/test-docker.yml

@@ -9,8 +9,8 @@ on:
       - master
 
 jobs:
-  build:
-    runs-on: ubuntu-20.04
+  test-docker:
+    runs-on: ubuntu-22.04
 
     steps:
       - uses: actions/checkout@v2

README.md

@@ -0,0 +1,85 @@
+# aleph-client
+
+Python Client for the [aleph.im network](https://www.aleph.im), next generation network of
+decentralized big data applications. Developement 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 .
+

docs/conf.py

@@ -13,9 +13,7 @@
 import shutil
 import sys
 
-__location__ = os.path.join(
-    os.getcwd(), os.path.dirname(inspect.getfile(inspect.currentframe()))
-)
+__location__ = os.path.join(os.getcwd(), os.path.dirname(inspect.getfile(inspect.currentframe())))
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the