hexo 0.1.0__tar.gz

hexo-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,108 @@
+name: CI & Publish
+
+on:
+  # Run tests on every PR to master
+  pull_request:
+    branches: [ master ]
+
+  # Run full pipeline (incl. publish) when something is pushed to master
+  # – this includes merges of PRs into master
+  push:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - python-version: "3.10"
+            experimental: false
+          - python-version: "3.11"
+            experimental: false
+          - python-version: "3.12"
+            experimental: false
+          - python-version: "3.13"
+            experimental: false
+          - python-version: "3.14"
+            experimental: true
+          - python-version: "3.15-dev"
+            experimental: true
+    continue-on-error: ${{ matrix.experimental }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install uv && uv sync
+
+      - name: Run tests
+        run: uv run pytest
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Get version from pyproject.toml
+        id: get_version
+        run: |
+          version=$(grep '^version =' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          echo "Detected version: $version"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Build distributions
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+          python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+
+    # Only publish on *push* to master (i.e. after a PR is merged)
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+
+    environment:
+      name: pypi
+      # Use the version detected from pyproject.toml in the environment URL
+      url: https://pypi.org/project/hexo/${{ needs.build.outputs.version }}
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

hexo-0.1.0/.gitignore

@@ -0,0 +1,164 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+

hexo-0.1.0/.idea/.gitignore

@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Ignored default folder with query files
+/queries/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

hexo-0.1.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

hexo-0.1.0/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="uv (python_template)" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="uv (hexo)" project-jdk-type="Python SDK" />
+</project>

hexo-0.1.0/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/python_template.iml" filepath="$PROJECT_DIR$/.idea/python_template.iml" />
+    </modules>
+  </component>
+</project>

hexo-0.1.0/.idea/python_template.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/.venv" />
+    </content>
+    <orderEntry type="jdk" jdkName="uv (hexo)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

hexo-0.1.0/.idea/runConfigurations/app.xml

@@ -0,0 +1,18 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="app" type="UvRunConfigurationType" factoryName="UvRunConfigurationType">
+    <option name="args">
+      <list />
+    </option>
+    <option name="checkSync" value="true" />
+    <option name="env">
+      <map />
+    </option>
+    <option name="runType" value="MODULE" />
+    <option name="scriptOrModule" value="app" />
+    <option name="uvArgs">
+      <list />
+    </option>
+    <option name="uvSdkKey" value="uv (python_template)" />
+    <method v="2" />
+  </configuration>
+</component>

hexo-0.1.0/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

hexo-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  # uv.lock update and requirement.txt generation (uncomment to enable)
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.10.0
+    hooks:
+      - id: uv-lock
+      # - id: uv-export
+
+  # Lint and format
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.14
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format
+
+  # Tests
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: uv run pytest -q
+        language: system
+        pass_filenames: false

hexo-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing to Hexo
+
+Thanks for contributing.
+
+## Before You Start
+
+- Read [RULES.md](RULES.md) to align with game behavior expectations.
+- Check existing issues and pull requests before opening new ones.
+
+## Reporting Issues
+
+When opening an issue, include:
+
+- clear title and concise summary
+- expected behavior vs actual behavior
+- minimal reproduction steps
+- environment details (OS, Python version, command used)
+- logs or traceback when relevant
+
+Use one issue per distinct bug or feature request.
+
+## Proposing Features
+
+- Describe the use case first, then the proposed API.
+- Call out rule or compatibility impacts.
+- Prefer incremental changes over large all-in-one proposals.
+
+## Pull Request Guidelines
+
+- Keep PRs focused and scoped to one change area.
+- Link the related issue (for example: `Closes #12`).
+- Add or update tests for behavior changes.
+- Update documentation when public API or behavior changes.
+- Ensure linting and tests pass locally before requesting review.
+
+## Development Setup
+
+```bash
+uv sync
+uv run pre-commit install
+```
+
+## Local Quality Checks
+
+```bash
+uv run pytest
+uvx ruff check . --fix
+uvx ruff format .
+```
+
+## Commit Guidance
+
+- Use clear commit messages in imperative form.
+- Explain why a change was made when not obvious from the diff.
+
+## Code Review Expectations
+
+- Be respectful and technical in review discussions.
+- Address feedback with follow-up commits.
+- If you disagree with feedback, document tradeoffs and rationale clearly.

hexo-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Pierre LAPOLLA]
+
+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:
+
+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,
+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.

hexo-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: hexo
+Version: 0.1.0
+Summary: A fast, reusable Python engine for Hexo on an infinite hex grid.
+Author: Pierre LAPOLLA
+License: MIT License
+        
+        Copyright (c) [2025] [Pierre LAPOLLA]
+        
+        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:
+        
+        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,
+        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.
+License-File: LICENSE
+Keywords: ai,board-game,connect-six,game-engine,hex-grid,hexo
+Requires-Python: >=3.10
+Requires-Dist: pedros>=0.12.3
+Description-Content-Type: text/markdown
+
+![Ruff](https://img.shields.io/badge/ruff-enabled-brightgreen)
+![License](https://img.shields.io/badge/license-MIT-green)
+
+# Hexo Engine
+
+Hexo is a Python engine for the Hexo game played on an infinite hex grid.
+
+The goal of this repository is to provide a clean, reusable engine API (similar in spirit to `python-chess`) so others can build bots, analysis tools, and frontends without re-implementing game logic.
+
+Game rules are documented in [RULES.md](RULES.md).
+Agent handoff context is documented in [AGENT_CONTEXT.md](AGENT_CONTEXT.md).
+
+## Features
+
+- Deterministic game engine with strict rule validation
+- Infinite hex-grid coordinate model
+- Opening and turn rules enforced by the engine
+- Win detection (connect 6 on any hex axis)
+- Undo support for search algorithms
+
+## Installation
+
+### Requirements
+
+- [UV](https://docs.astral.sh/uv/) package manager
+
+### Clone the repository
+
+```bash
+  git clone https://github.com/<your-org>/hexo.git
+  cd hexo
+```
+
+### Initialize your environment
+
+```bash
+  uv sync
+  uv run pre-commit install
+```
+
+## API
+
+Public entry point is the `Hexo` class.
+
+- `Hexo.new(config=None) -> Hexo`: create a new game with `P1` already placed at `(0, 0)`.
+- `Hexo.from_state(state, config=None) -> Hexo`: restore a game from serialized state.
+- `game.to_state() -> dict`: serialize committed turns and any in-progress partial turn.
+- `game.turn() -> Player`: return the player currently placing stones.
+- `game.status() -> GameStatus`: return `ONGOING`, `P1_WON`, or `P2_WON`.
+- `game.moves_left_in_turn() -> int`: return remaining moves in current turn (`2` or `1`).
+- `game.pending_moves() -> tuple[Coord, ...]`: return moves already made in the current turn.
+- `game.is_legal_move(coord) -> tuple[bool, str | None]`: validate one submove.
+- `game.legal_moves() -> tuple[Coord, ...]`: return legal single-move candidates.
+- `game.push(coord) -> TurnRecord | None`: play one move; returns `None` if turn is still partial, or `TurnRecord` when the turn completes (or wins early).
+- `game.is_legal(move) -> tuple[bool, str | None]`: validate a full 2-stone move (only when no partial turn is active).
+- `game.play(move) -> TurnRecord`: convenience wrapper that places two stones in sequence.
+- `game.undo() -> TurnRecord`: undo the last placement (works for both partial and completed turns).
+- `game.at(coord) -> Player | None`: inspect occupancy at a coordinate.
+- `game.board() -> dict[Coord, Player]`: get a snapshot of all occupied coordinates.
+
+Notes:
+
+- `Hexo.new()` starts with `P1` already placed at `(0, 0)`.
+- Every played turn is a 2-stone move.
+
+## Quickstart
+
+```python
+from hexo import Hexo
+
+game = Hexo.new()
+print(game.turn())  # Player.P2
+
+legal, reason = game.is_legal_move((1, 0))
+if not legal:
+    raise ValueError(reason)
+game.push((1, 0))
+
+# Hook point for engines: run a search after first placement.
+# ... search code here ...
+
+record = game.push((0, 1))  # turn completes here
+print(record)  # TurnRecord
+print(game.moves_left_in_turn())  # 2
+
+state = game.to_state()
+restored = Hexo.from_state(state)
+print(restored.turn())
+```
+
+## Tests, linting and formatting
+
+```bash
+uv run pytest
+```
+
+```bash
+uvx ruff check . --fix
+```
+
+```bash
+uvx ruff format .
+```
+
+Run all hooks manually:
+
+```bash
+uv run pre-commit run --all-files
+```
+
+## Benchmarks
+
+Benchmarking uses `pytest-benchmark` and is kept separate from normal tests.
+
+Run benchmarks:
+
+```bash
+uv run pytest benchmarks --benchmark-only
+```
+
+Save a baseline:
+
+```bash
+uv run pytest benchmarks --benchmark-only --benchmark-save=baseline
+```
+
+Compare with a saved baseline:
+
+```bash
+uv run pytest benchmarks --benchmark-only --benchmark-compare=baseline
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for:
+
+- issue reporting guidelines
+- feature proposal flow
+- pull request requirements
+- code style and testing expectations
+
+## License
+
+This project is licensed under the MIT [LICENSE](LICENSE)