chess-results-api 0.1.0__tar.gz

chess_results_api-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local tournament data (not redistributed with the package)
+/tests/fixtures/

chess_results_api-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.0 — 2026-09-28
+
+Initial release for Python 3.12+.
+
+- Decode Swiss-Manager TUNX, TURX, TUTX, and TUMX files through
+  `load_tournament` and `decode_tournament`.
+- Read tournament metadata, players, teams, schedules, pairings, results, and
+  team board scores as typed records, preserving unknown fields and source bytes.
+- Download files with `download_tournament` using optional Playwright/Chromium,
+  isolated sessions, tournament-ID validation, and reduced page traffic.
+- Support local decoding without runtime dependencies. Distribute the `py.typed`
+  marker for type checkers.
+
+The decoder is experimental and covers observed binary layouts. Scoring assumes
+1 / ½ / 0; official rankings and tie-breaks are not calculated. Downloading depends
+on the Chess-Results website and requires a separate Chromium installation.
+Local tournament binaries and reference snapshots are excluded from distributions.

chess_results_api-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing
+
+## Development
+
+Use Python 3.12+ and [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --locked --extra browser
+uv run playwright install chromium
+```
+
+This creates `.venv` with the package, pytest, Ruff, and Playwright. For decoder
+work only, omit `--extra browser` and the Chromium installation. Update
+`pyproject.toml` and `uv.lock` together when changing dependencies.
+
+Before opening a PR:
+
+```sh
+uv run ruff format .
+uv run ruff check .
+uv run pytest
+uv build
+```
+
+CI runs on pull requests and pushes to `main`: Ubuntu Python 3.12–3.14, Windows
+3.12, and macOS 3.12. Describe the change and its validation in the PR.
+
+## Commits and branches
+
+Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+for commits and squash-merge PR titles:
+
+```text
+<type>[optional scope][!]: <description>
+```
+
+Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`,
+`chore`, or `revert`. Use an imperative description. Mark breaking changes with
+`!` and explain the migration in a `BREAKING CHANGE:` footer.
+
+Branch names use `<type>/<short-description>` with lowercase, hyphen-separated
+words, such as `feat/tournament-download` or `fix/empty-player-slots`.
+
+## Code and tests
+
+Keep changes focused, readable, and typed. Prefer small functions and explicit
+data flow. Document decoder evidence in the [format notes](docs/swiss-manager-format.md),
+preserve unidentified bytes, and check boundaries, references, missing values,
+dates, and score units. Add regression or edge-case tests for behavior changes.
+
+Tests must run offline; browser tests intercept requests. Keep local binaries and
+reference snapshots in `tests/fixtures/`, which is ignored by Git and excluded
+from distributions. Never force-add fixtures. Tests requiring missing fixtures
+or browser installations skip; use synthetic data for portable coverage.
+
+## Releasing
+
+1. Prepare `release/v<version>` with matching versions in `pyproject.toml` and
+   `citations.cff`, dated release notes in `CHANGELOG.md`, and updated README text.
+2. Merge the preparation PR into `main` and confirm CI passes.
+3. Tag the release commit on `main` and push that tag:
+
+   ```sh
+   git switch main
+   git pull --ff-only
+   git tag -a v0.1.0 -m "Release v0.1.0"
+   git push origin v0.1.0
+   ```
+
+The [Publish workflow](.github/workflows/publish.yml) runs on `v*` tag pushes.
+It verifies that the tagged commit belongs to `main` and the tag matches the
+package version, builds and tests the wheel, then publishes the same artifacts
+to TestPyPI followed by PyPI. Publishing uses the existing Trusted Publishers
+and GitHub environments. Creating a GitHub release does not trigger publishing.
+
+Published versions are immutable. For a partial workflow failure, rerun failed
+jobs; use a new version for changed distributions rather than moving a release tag.

chess_results_api-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

chess_results_api-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.5
+Name: chess-results-api
+Version: 0.1.0
+Summary: Download Chess-Results tournament files and decode them into typed Python records.
+Project-URL: Repository, https://github.com/zyf0717/chess-results-api
+Project-URL: Documentation, https://github.com/zyf0717/chess-results-api#readme
+Project-URL: Issues, https://github.com/zyf0717/chess-results-api/issues
+Project-URL: Changelog, https://github.com/zyf0717/chess-results-api/blob/main/CHANGELOG.md
+Author-email: Yifei Zheng <zyf0717@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Games/Entertainment :: Board Games
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Provides-Extra: browser
+Requires-Dist: playwright<2,>=1.51; extra == 'browser'
+Description-Content-Type: text/markdown
+
+# chess-results-api
+
+[![PyPI version](https://img.shields.io/pypi/v/chess-results-api)](https://pypi.org/project/chess-results-api/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://github.com/zyf0717/chess-results-api/blob/main/pyproject.toml)
+[![CI](https://github.com/zyf0717/chess-results-api/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/zyf0717/chess-results-api/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/zyf0717/chess-results-api/blob/main/LICENSE)
+
+An experimental Python 3.12+ package for downloading Chess-Results tournament
+files and decoding Swiss-Manager data. Supports individual Swiss (TUNX), individual
+round-robin (TURX), team round-robin (TUTX), and team Swiss (TUMX).
+Local decoding has no runtime dependencies; downloading uses optional Playwright.
+
+## Installation
+
+Install into a virtual environment using
+[uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```sh
+uv venv --python 3.12
+uv pip install chess-results-api
+```
+
+## Usage
+
+```python
+from chess_results_api import load_tournament
+
+tournament = load_tournament("tournament.TUMX")
+print(tournament.metadata.name, tournament.tournament_type.name)
+for round_ in tournament.rounds:
+    for game in round_.games:
+        print(game.white_player, game.black_player, game.result, game.points)
+```
+
+`load_tournament(path)` and `decode_tournament(data: bytes)` detect the format from
+its contents and return frozen, typed records for metadata, players, teams,
+rounds, pairings, and scores. Detected malformed or unsupported layouts raise
+`SwissManagerDecodeError`; filesystem errors propagate unchanged.
+
+The decoder uses standard 1 / ½ / 0 scoring. Unknown results remain unscored, and
+unidentified data is preserved. It does not calculate rankings or tie-breaks.
+Player and team references are one-based, with special values for empty slots,
+byes, and unpaired entries. See the
+[format notes](https://github.com/zyf0717/chess-results-api/blob/main/docs/swiss-manager-format.md)
+for these conventions, observed layouts, and validation limits.
+
+## Download a tournament
+
+Install the browser extra and Chromium once:
+
+```sh
+uv pip install "chess-results-api[browser]"
+uv run --no-project playwright install chromium
+```
+
+```python
+from chess_results_api import download_tournament, load_tournament
+
+path = download_tournament(1502346, "tournament.TUNX")
+tournament = load_tournament(path)
+```
+
+The downloader opens the details form and follows the file link in an isolated
+browser session, blocking images, fonts, and media to reduce page traffic.
+It validates the binary and tournament ID before writing the
+destination, replacing an existing file. The parent directory must exist.
+Browser failures or unavailable downloads raise `TournamentDownloadError`;
+unsupported binaries raise `SwissManagerDecodeError`. Options include
+`timeout=30` (seconds per browser operation) and `headless=False`.
+
+## Development
+
+From a repository checkout:
+
+```sh
+uv sync --locked --extra browser
+uv run playwright install chromium
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv build
+```
+
+Local binaries and reference snapshots belong in `tests/fixtures/`, which is
+ignored by Git and excluded from distributions. Tests requiring missing fixtures
+skip; synthetic tests run offline without them. `uv build` creates distribution
+archives in `dist/`. Built wheels can be installed locally with
+`uv pip install dist/chess_results_api-0.1.0-py3-none-any.whl`.
+Browser tests use intercepted requests and skip when Playwright or Chromium is absent.
+
+See [CONTRIBUTING.md](https://github.com/zyf0717/chess-results-api/blob/main/CONTRIBUTING.md)
+for commit and branch conventions,
+[CHANGELOG.md](https://github.com/zyf0717/chess-results-api/blob/main/CHANGELOG.md)
+for release notes, and
+[citations.cff](https://github.com/zyf0717/chess-results-api/blob/main/citations.cff)
+for citation metadata.