bittensor-pylon-client 0.1.0__tar.gz

bittensor_pylon_client-0.1.0/.dockerignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.env
+.git
+.gitignore
+README.md
+Dockerfile

bittensor_pylon_client-0.1.0/.github/actions/setup-python-env/action.yml

@@ -0,0 +1,22 @@
+name: Setup python env
+description: Set up Python with uv and nox
+
+inputs:
+  python-version:
+    description: Python version to use
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7.1.3
+
+    - name: Install nox
+      shell: bash
+      run: pip install nox==2025.11.12

bittensor_pylon_client-0.1.0/.github/actions/validate-version/action.yml

@@ -0,0 +1,49 @@
+name: Validate Version
+description: Validates that the git tag version matches the version in code
+
+inputs:
+  tag-prefix:
+    description: 'Prefix to strip from the tag (e.g., "client-v" or "service-v")'
+    required: true
+  version-file:
+    description: 'Path to the file containing __version__ (e.g., "pylon/__init__.py")'
+    required: true
+
+outputs:
+  version:
+    description: 'The extracted version from the tag'
+    value: ${{ steps.extract.outputs.VERSION }}
+
+runs:
+  using: composite
+  steps:
+    - name: Extract version from tag
+      id: extract
+      shell: bash
+      run: |
+        TAG="${GITHUB_REF#refs/tags/}"
+        VERSION="${TAG#${{ inputs.tag-prefix }}}"
+        echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+        echo "Extracted version: $VERSION"
+
+    - name: Get version from code
+      id: code_version
+      shell: bash
+      run: |
+        CODE_VERSION=$(sed -n 's/^__version__ = "\(.*\)"/\1/p' ${{ inputs.version-file }})
+        echo "CODE_VERSION=$CODE_VERSION" >> $GITHUB_OUTPUT
+        echo "Version in ${{ inputs.version-file }}: $CODE_VERSION"
+
+    - name: Validate version match
+      shell: bash
+      run: |
+        TAG_VERSION="${{ steps.extract.outputs.VERSION }}"
+        CODE_VERSION="${{ steps.code_version.outputs.CODE_VERSION }}"
+
+        if [ "$TAG_VERSION" != "$CODE_VERSION" ]; then
+          echo "::error::Version mismatch! Tag version ($TAG_VERSION) does not match code version ($CODE_VERSION)"
+          echo "Please update ${{ inputs.version-file }} to match the tag version."
+          exit 1
+        fi
+
+        echo "Version validation passed: $TAG_VERSION"

bittensor_pylon_client-0.1.0/.github/workflows/cd-docker.yml

@@ -0,0 +1,53 @@
+name: CD Docker
+
+on:
+  push:
+    tags:
+      - 'service-v*'
+
+env:
+  DOCKER_REPO_NAME: "backenddevelopersltd/bittensor-pylon"
+
+permissions:
+  contents: read
+
+jobs:
+  validate-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.validate.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate version
+        id: validate
+        uses: ./.github/actions/validate-version
+        with:
+          tag-prefix: 'service-v'
+          version-file: 'pylon/service/__init__.py'
+
+  docker-push:
+    runs-on: ubuntu-latest
+    needs: validate-version
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_KEY }}
+
+      - name: Build and push image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            ${{ env.DOCKER_REPO_NAME }}:${{ needs.validate-version.outputs.version }}
+            ${{ env.DOCKER_REPO_NAME }}:latest
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

bittensor_pylon_client-0.1.0/.github/workflows/cd-pypi.yml

@@ -0,0 +1,56 @@
+name: CD PyPI
+
+on:
+  push:
+    tags:
+      - 'client-v*'
+
+permissions:
+  contents: read
+
+jobs:
+  validate-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.validate.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate version
+        id: validate
+        uses: ./.github/actions/validate-version
+        with:
+          tag-prefix: 'client-v'
+          version-file: 'pylon/__init__.py'
+
+  release-build:
+    runs-on: ubuntu-latest
+    needs: validate-version
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Build release distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs: [validate-version, release-build]
+    permissions:
+      id-token: write
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

bittensor_pylon_client-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+    tags:
+      - 'client-v*'
+      - 'service-v*'
+  pull_request:
+
+env:
+  TAG_VERSION: "v1-latest"
+  DOCKER_REPO_NAME: "backenddevelopersltd/bittensor-pylon"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup python env
+        uses: ./.github/actions/setup-python-env
+        with:
+          python-version: '3.12'
+
+      - name: Run linting checks with nox
+        run: nox -s lint
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup python env
+        uses: ./.github/actions/setup-python-env
+        with:
+          python-version: '3.12'
+
+      - name: Create dotenv file
+        run: cp ./pylon/service/envs/test_env.template .env
+
+      - name: Run unit tests with nox
+        env:
+          PYLON_DOCKER_IMAGE_NAME: ${{ env.DOCKER_REPO_NAME }}:${{ env.TAG_VERSION }}
+        run: nox -s test
+

bittensor_pylon_client-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+.venv/
+*.__pycache__/
+*.pyc
+*.db
+.DS_Store
+.env*
+.vscode
+bittensor_pylon.egg-info/
+bittensor_pylon.sqlite3
+build/
+.turbobt/
+.idea/
+.junie/
+docker-compose.yaml
+_ignore_*

bittensor_pylon_client-0.1.0/CHECKLISTS.md

@@ -0,0 +1,26 @@
+# Checklists
+
+This file contains checklists of things that must be done when implementing a specific kind of feature. Developers
+are encouraged to follow the checklist to not forget anything before posting a PR. The checklists may be handy for
+LLM agents to make a review or implement missing steps.
+
+If no proper feature category is here, it may be added if needed.
+
+## Adding new endpoint to the Pylon service
+
+* Add the endpoint
+* Add endpoint tests in tests/service:
+  * success (with and without optional parameters if applicable)
+  * edge cases (for example empty response, edge parameters etc.)
+  * validation errors
+  * other possible errors
+* All a PylonRequest and a PylonResponse for the Pylon client.
+  * PylonRequest should be used as an input data for write endpoints (unless it does not contain any parameters)
+  * Implement a proper translation for PylonRequest in the Pylon client
+  * Expose the PylonRequest and PylonResponse by the public interface (apiver)
+* Add tests for the pylon client in tests/client:
+  * proper response from api (with and without optional parameters if applicable)
+  * edge cases if any applicable
+  * pylon request validation errors
+  * other possible errors
+* Check if the information in README is not stale.