Merge pull request #80 from Geodefi/dev

v3.1.0

.github/workflows/pypi_publish.yml

@@ -0,0 +1,33 @@
+name: Build and publish python 🐍 package 📦 to PyPI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-publish-to-pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Setup Python 3.10
+        uses: actions/[email protected]
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+
+      - name: Configure Poetry
+        run: |
+          poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
+      #   poetry config pypi-token.test-pypi ${{ secrets.TEST_PYPI_TOKEN }}
+      #   poetry config repositories.test-pypi https://test.pypi.org/legacy/
+      - name: Publish to PyPI
+        run: |
+          poetry publish --build
+      #   poetry publish --build -r test-pypi

.github/workflows/release_pull_request.yml

@@ -0,0 +1,49 @@
+name: Release preparation
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-preparation:
+    name: Release preparation & PR creation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          persist-credentials: false
+          ref: dev
+
+      - name: Update version
+        id: version-update
+        uses: TriPSs/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          git-message: "chore(release): {version}"
+          tag-prefix: ""
+          version-file: pyproject.toml
+          version-path: tool.poetry.version
+          create-summary: true
+          skip-ci: false
+          skip-on-empty: false
+          git-push: false
+
+      - name: missing version output
+        if: ${{ !steps.version-update.outputs.version }}
+        run: >
+          echo "ERROR: Version output is missing from the previous step!" && exit 1
+
+      - name: Create Pull Request on dev
+        uses: peter-evans/[email protected]
+        id: cpr-dev
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: release-${{ steps.version-update.outputs.version }}
+          title: "chore: update version to ${{ steps.version-update.outputs.version }} on dev"
+          body: ">To keep the version on dev branch up-to-date, this PR should be merged before merging dev into the main branch in the following PR. Which will trigger pypi release with the updated version.\n\nThis is an automatic PR created by github actions.\nClose and delete branch in case it is not needed."
+          assignees: geode-main
+          reviewers: geode-main

CHANGELOG.md

@@ -0,0 +1,36 @@
+# [3.1.0](https://github.com/Geodefi/geode-py/compare/1.3.0...3.1.0) (2024-08-20)
+
+
+### Bug Fixes
+
+* error messages and docs. implement the new ci pipeline ([8bd014f](https://github.com/Geodefi/geode-py/commit/8bd014f47ea8192bd770a26ecc04cd1bfb7e0267))
+* fix hexbyte input issue on to_bytes32 ([6dbabf9](https://github.com/Geodefi/geode-py/commit/6dbabf9310dd98bbda2ab480b52405ce187a307f))
+* include src subfolders when published ([5830a86](https://github.com/Geodefi/geode-py/commit/5830a862e47cce09af3d8abd732bbdb457c214dd))
+* remove old poetry setting for src ([816b6f6](https://github.com/Geodefi/geode-py/commit/816b6f65cc30ced80741062c42e9db37d34d7eb7))
+* remove sphinx_search.extension for rtd ([32685e7](https://github.com/Geodefi/geode-py/commit/32685e72fea02e8b6f39dcd25dbd43c7bf764e68))
+* sphinx-copybutton deps for docs ([0b287dd](https://github.com/Geodefi/geode-py/commit/0b287dd3200364f3c5d0e249dec7e93b50ea26f3))
+* sphinx-rtd-theme deps for docs ([6e8a230](https://github.com/Geodefi/geode-py/commit/6e8a230c181a679d189408d5d9a3d11c96368028))
+* sphinx-rtd-theme deps for docs on requirements.txt for rtd.org ([00b4547](https://github.com/Geodefi/geode-py/commit/00b4547dc979da8f4459664471487d830d6a0715))
+
+
+### Features
+
+* remove unnecessary bls and merkle codes ([122ac0b](https://github.com/Geodefi/geode-py/commit/122ac0bc06e15911f3125b4801ccf20c81c03cb4))
+* rename folder name to src. fix some small issues ([394b8b3](https://github.com/Geodefi/geode-py/commit/394b8b3aacedba983ba12eaac9bcef4974c081db))
+* Update codebase to use poetry. BREAKING CHANGE ([8e0128d](https://github.com/Geodefi/geode-py/commit/8e0128d491ba25993497b45f3e73c53eaf73bcee))
+
+
+### Reverts
+
+* use release/v1 as gh action version ([e7c0673](https://github.com/Geodefi/geode-py/commit/e7c06732535b23630c62f48f87b122d8064d006b))
+
+
+
+# [1.3.0](https://github.com/Geodefi/geode-py/compare/1.2.3...1.3.0) (2023-09-26)
+
+
+
+# [1.2.0](https://github.com/Geodefi/geode-py/compare/1.1.1...1.2.0) (2023-09-25)
+
+
+

README.md

@@ -16,7 +16,7 @@ Whether you're looking to query contract data or execute transactions, **geodefi
 - Provides a simple and intuitive API for managing validators, operators, pools, tokens, and other smart contracts/packages.
 - Dynamically adapts to the contract upgrades.
 - Mostly chain agnostic. However, might differ according to the unique PoS implementations.
-- Compatible from Python 3.8 to Python 3.12.
+- Compatible with Python versions that are bigger than 3.8.
 
 ## Installation
 

docs/index.rst

@@ -61,8 +61,7 @@ Table of Contents
     :caption: Examples
 
     internal_wallet
-    creating_validators
-    .. staking_pool_handbook
+    staking_pool_handbook
 
 .. toctree::
     :maxdepth: 1

docs/installation.rst

@@ -8,7 +8,7 @@ Before Installation
 ===================
 
 .. WARNING::
-  **geodefi** Python SDK (as of v2.0.0) only supports the Python versions from ``3.8`` to ``3.12``.  
+  **geodefi** Python SDK (as of v2.0.0) only supports the Python versions bigger than ``3.8``.  
 
 .. NOTE::
   We recommend that you read protocol's `documentation <https://docs.geode.fi>`_ to become familiar with the terms.
@@ -23,7 +23,7 @@ Before Installation
 .. code-block:: shell
    
   $ python3 --version 
-  # Python 3.8.0 - 3.12.3
+  # Python 3.8.0 
 
 2. Create a virtual environment
 =========================================

docs/operator.rst

@@ -175,5 +175,3 @@ To understand why some operators have prisoned read `this link <https://docs.geo
 
 More 
 ----
-
-Next step: Learn how to create validators through geodefi: :ref:`creating_validators`

geodefi/utils/version.py

@@ -9,5 +9,5 @@ def check_python_version() -> None:
 
     if sys.version_info <= (3, 8) and sys.version_info >= (3, 12):
         raise PythonVersionError(
-            f"Python version is not supported.Please consider using 3.8-3.12"
+            f"Python version is not supported. Consider using >3.8"
         )