PyDiffGame 1.0.0__tar.gz → 2.0.1__tar.gz

pydiffgame-2.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,132 @@
+# Publishes the package to PyPI and creates the matching GitHub Release,
+# auto-incrementing the version each run.
+#
+# Flow (just run it — Actions -> Upload Python Package -> Run workflow):
+#   1. bump-version  : increment the version (carry-at-9 via tools/bump_version.py),
+#                      commit it back to master.
+#   2. release-build : build the dists from the bumped master.
+#   3. pypi-publish  : upload to PyPI via Trusted Publishing (OIDC, no tokens).
+#   4. github-release: create the v<version> GitHub Release with notes + dists.
+#
+# Versions roll over at 9: 2.0.9 -> 2.1.0, 2.9.9 -> 3.0.0.
+
+name: Upload Python Package
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      version: ${{ steps.bump.outputs.version }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: master
+
+      - name: Increment the version (carry-at-9)
+        id: bump
+        run: |
+          new="$(python3 tools/bump_version.py)"
+          echo "version=$new" >> "$GITHUB_OUTPUT"
+          echo "Bumped to $new"
+
+      - name: Commit and push the bump
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add pyproject.toml src/PyDiffGame/__init__.py
+          git commit -m "chore: bump version to ${{ steps.bump.outputs.version }} [skip ci]"
+          git push origin HEAD:master
+
+  release-build:
+    needs: bump-version
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: master  # the bumped commit
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build release distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    needs:
+      - release-build
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/PyDiffGame/
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+      # Authentication is via PyPI Trusted Publishing (OIDC) — no token needed.
+      # Trusted publisher on PyPI: owner krichelj, repo PyDiffGame,
+      # workflow python-publish.yml, environment pypi.
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          # Don't fail if this version is already on PyPI (idempotent re-runs).
+          skip-existing: true
+
+  github-release:
+    needs:
+      - bump-version
+      - pypi-publish
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to create the release and its tag.
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: master
+
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Create or update the GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ needs.bump-version.outputs.version }}
+        run: |
+          tag="v${VERSION}"
+          echo "Releasing ${tag}"
+          if gh release view "$tag" >/dev/null 2>&1; then
+            echo "Release ${tag} already exists - refreshing its assets."
+            gh release upload "$tag" dist/* --clobber
+          else
+            gh release create "$tag" dist/* \
+              --title "$tag" \
+              --generate-notes \
+              --target master
+          fi

pydiffgame-2.0.1/.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+name: Tests
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Sync the environment (locked)
+        run: uv sync --extra dev --python ${{ matrix.python-version }} --frozen
+
+      - name: Lint with ruff
+        run: uv run ruff check src/PyDiffGame tests --exclude src/PyDiffGame/examples
+
+      - name: Check formatting with ruff
+        run: uv run ruff format --check src/PyDiffGame tests
+
+      - name: Type-check with mypy
+        run: uv run mypy src/PyDiffGame --exclude 'examples'
+
+      - name: Run the test suite
+        env:
+          MPLBACKEND: Agg
+        run: uv run pytest -q

pydiffgame-2.0.1/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+build/
+dist/
+*.so
+
+# Virtual environments
+.venv*/
+venv/
+env/
+
+# Test / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# OS / editors
+.DS_Store
+.idea/
+.vscode/

pydiffgame-2.0.1/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# Pre-commit hooks for PyDiffGame.
+# Install once with:  pre-commit install
+# Run on everything:  pre-commit run --all-files
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      # Linter (with autofix), then the black-compatible formatter.
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        files: ^src/PyDiffGame/
+        exclude: ^src/PyDiffGame/examples/
+        additional_dependencies: [numpy]

pydiffgame-2.0.1/CLAUDE.md

@@ -0,0 +1,32 @@
+# PyDiffGame — repository guide for Claude
+
+## Python tooling (uv-first)
+- Use **uv** for everything; pip is only a documented fallback.
+  - `uv sync --extra dev`, `uv run pytest`, `uv run ruff check`, `uv run ruff format`,
+    `uv run mypy src/PyDiffGame`, `uv build`.
+- Keep the quality gates green before committing: ruff format, ruff check, mypy on
+  `src/PyDiffGame`, and the pytest suite — all via `uv run`.
+
+## Versioning (carry-at-9)
+- The version is `X.Y.Z` with single-digit components that roll over at 9:
+  `2.0.9 -> 2.1.0`, `2.9.9 -> 3.0.0` (the major keeps growing).
+- Increment **only** via `tools/bump_version.py`, which updates the version in both
+  `pyproject.toml` and `src/PyDiffGame/__init__.py`. Never hand-edit version strings.
+- The version is bumped **automatically** by the publish workflow on each release, so
+  do not bump it in ordinary PRs — the release run does it.
+
+## Releasing
+- `Actions -> Upload Python Package -> Run workflow` (on `master`). The workflow
+  auto-increments the version, commits it to `master`, builds with `uv build`,
+  publishes to PyPI via Trusted Publishing (OIDC, no tokens), and creates the matching
+  `v<version>` GitHub Release with notes and the built dists attached. It is idempotent
+  (`skip-existing`).
+
+## Docs
+- `README.md` is the single canonical readme and is also the PyPI long-description
+  (`pyproject.toml: readme = "README.md"`), so its image/file links must be **absolute**
+  (`raw.githubusercontent.com/.../master/...` for images, `github.com/.../blob/master/...`
+  for files) so they render on PyPI.
+- Keep `docs/README.md` identical to `README.md`.
+- README figures are generated from the live solver:
+  `uv run python tools/generate_readme_figures.py`.

{pydiffgame-1.0.0 → pydiffgame-2.0.1}/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-.
+skricheli2@gmail.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

pydiffgame-2.0.1/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contribution Guidelines
+
+This repo is part of a research conducted at Ben Gurion University,
+and is thus open source. We would love to receive your input!
+
+Please ensure your pull request adheres to the following guidelines:
+
+- Search previous suggestions before making a new one, as yours may be a duplicate.
+- Make an individual pull request for each suggestion.
+- New categories or improvements to the existing categorization are welcome.
+- Check your spelling and grammar.
+- Make sure your text editor is set to remove trailing whitespace.
+- The pull request and commit should have a useful title.
+
+## Development setup
+
+PyDiffGame requires **Python >= 3.11** and uses [uv](https://docs.astral.sh/uv/)
+for environment and dependency management. Install uv, sync the locked
+development environment, and enable the pre-commit hooks so the code-quality
+tools run automatically on every commit:
+
+```bash
+# install uv: https://docs.astral.sh/uv/getting-started/installation/
+uv sync --extra dev
+uv run pre-commit install
+```
+
+`uv sync` creates the virtual environment and installs the exact, locked
+dependencies. Run the tooling through `uv run`:
+
+```bash
+uv run ruff format src/PyDiffGame tests   # auto-format (black-compatible)
+uv run ruff check src/PyDiffGame tests    # lint
+uv run mypy src/PyDiffGame                # type-check
+uv run pytest                             # test suite
+```
+
+Continuous integration runs the formatter check, the linter, the type checker
+and the full suite (all via uv) across Python 3.11–3.14, so please make sure
+they pass locally.
+
+## Releasing
+
+Publishing a new version is a single automated step — just run the publish
+workflow: **Actions -> Upload Python Package -> Run workflow** (on `master`).
+
+The run automatically:
+
+1. **Increments the version** with `tools/bump_version.py`, which rolls each
+   component over at 9 (`2.0.9 -> 2.1.0`, `2.9.9 -> 3.0.0`), updating both
+   `pyproject.toml` and `src/PyDiffGame/__init__.py`, and commits the bump to
+   `master`.
+2. Builds the distributions with `uv build`.
+3. Uploads them to PyPI via
+   [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) (OIDC — no
+   tokens or secrets).
+4. Creates a `v<version>` GitHub Release with auto-generated notes and the built
+   wheels/sdist attached.
+
+You normally never edit the version by hand. To bump it locally (e.g. to test),
+run `uv run python tools/bump_version.py` (`--dry-run` to preview, `--current`
+to print the current version). The PyPI upload is idempotent (`skip-existing`),
+so re-running the workflow is safe.
+
+Thank you for your contribution!
+
+Joshua Shay Kricheli