batman

Author: antonvice

.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+# .github/workflows/publish.yml
+
+name: Publish to PyPI
+
+# This workflow runs when a new tag is pushed that starts with 'v'
+# e.g., v0.1.0, v1.2.3
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    
+    # These permissions are necessary to authenticate with PyPI using OpenID Connect.
+    # It's a more secure method than using a long-lived API token.
+    permissions:
+      id-token: write # This is required for trusted publishing
+      
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: python -m pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No API token is needed in the 'with' block. 
+        # The action automatically handles authentication via the id-token permission.

.github/workflows/python-package.yml

@@ -1,40 +1,46 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+# .github/workflows/python-package.yml
 
-name: Python package
+name: CI
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "master", "main" ] # Also works on 'main' branch
   pull_request:
-    branches: [ "master" ]
+    branches: [ "master", "main" ]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] # Adjusted for modern versions
 
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout code
+      uses: actions/checkout@v4 # Use the latest version
+
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5 # Use the latest version
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 goroutine-py 
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
+        # This command installs the project from local files in editable mode (-e)
+        # and includes the [test] dependencies from pyproject.toml
+        python -m pip install -e ".[test]"
+
+    - name: Lint with flake8, black, and isort
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test demo
+        # Check formatting with black
+        black --check .
+        # Check import sorting with isort
+        isort --check .
+
+    - name: Run tests with pytest
       run: |
-        python demo.py
+        pytest

.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+*.whl
+*.tar.gz
+
+# Virtual environment
+venv/
+.venv/
+
+# Test artifacts
+.pytest_cache/
+.coverage
+
+# IDEs
+.vscode/
+.idea/
+
+# macOS
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+# .pre-commit-config.yaml
+repos:
+-   repo: https://github.com/psf/black
+    rev: 24.4.2 
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort

.python-version

@@ -0,0 +1 @@
+3.12.6

LICENSE

@@ -1,21 +1,21 @@
 MIT License
 
-Copyright (c) 2022 ZIHAN MA
+Copyright (c) 2025 Anton Vice
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+furnished to do so, to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+IMPLIED, INCLUDING BUT NOTLIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.