gamesheet-sdk-py 0.0.1a1__tar.gz

gamesheet_sdk_py-0.0.1a1/.gitignore

@@ -0,0 +1,104 @@
+# ---- Byte-compiled / cached ----
+__pycache__/
+*.py[cod]
+*$py.class
+*.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 ----
+*.manifest
+*.spec
+
+# ---- Installer logs ----
+pip-log.txt
+pip-delete-this-directory.txt
+
+# ---- Unit test / coverage ----
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# ---- Type checkers / linters ----
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+.ruff_cache/
+
+# ---- Virtual environments ----
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# ---- Tooling: Poetry / Pipenv / pdm / Hatch ----
+poetry.lock
+Pipfile.lock
+.pdm.toml
+.pdm-python
+.pdm-build/
+.hatch/
+
+# ---- Jupyter ----
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+
+# ---- Playwright (browser binaries handled separately) ----
+.playwright/
+playwright-report/
+test-results/
+
+# ---- IDE / editor ----
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# ---- Sphinx documentation ----
+docs/_build/
+_autosummary/
+
+# ---- hatch-vcs generated version file ----
+src/gamesheet_sdk/_version.py
+
+# ---- Local scratch ----
+*.log
+.local/
+secrets.toml

gamesheet_sdk_py-0.0.1a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bdperkin
+
+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.

gamesheet_sdk_py-0.0.1a1/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: gamesheet-sdk-py
+Version: 0.0.1a1
+Summary: Unofficial Python SDK and CLI for the GameSheet Inc. platform — automates WebUI procedures where a native API is absent.
+Project-URL: Homepage, https://github.com/bdperkin/gamesheet-sdk-py
+Project-URL: Repository, https://github.com/bdperkin/gamesheet-sdk-py
+Project-URL: Issues, https://github.com/bdperkin/gamesheet-sdk-py/issues
+Project-URL: Documentation, https://github.com/bdperkin/gamesheet-sdk-py#readme
+Author: bdperkin
+License: MIT License
+        
+        Copyright (c) 2026 bdperkin
+        
+        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: automation,cli,gamesheet,hockey,scraper,sdk,sports
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.11
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: click>=8.1
+Requires-Dist: lxml>=5.2
+Requires-Dist: playwright>=1.45
+Requires-Dist: pydantic>=2.7
+Requires-Dist: requests>=2.32
+Provides-Extra: dev
+Requires-Dist: bandit[toml]>=1.7; extra == 'dev'
+Requires-Dist: black>=26.3; extra == 'dev'
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: codespell>=2.4; extra == 'dev'
+Requires-Dist: editorconfig-checker>=3.6; extra == 'dev'
+Requires-Dist: flake8-pyproject>=1.2; extra == 'dev'
+Requires-Dist: flake8>=7.1; extra == 'dev'
+Requires-Dist: isort>=5.13; extra == 'dev'
+Requires-Dist: mdformat-gfm>=0.4; extra == 'dev'
+Requires-Dist: mdformat>=0.7; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-playwright>=0.5; extra == 'dev'
+Requires-Dist: pytest-recording>=0.13; extra == 'dev'
+Requires-Dist: pytest>=8.2; extra == 'dev'
+Requires-Dist: pyupgrade>=3.19; extra == 'dev'
+Requires-Dist: tox>=4.21; extra == 'dev'
+Requires-Dist: types-requests>=2.32; extra == 'dev'
+Requires-Dist: validate-pyproject>=0.25; extra == 'dev'
+Requires-Dist: yamllint>=1.38; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.5; extra == 'docs'
+Requires-Dist: myst-parser[linkify]>=3.0; extra == 'docs'
+Requires-Dist: sphinx-argparse>=0.4; extra == 'docs'
+Requires-Dist: sphinx-autobuild>=2024.4; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
+Requires-Dist: sphinx-design>=0.5; extra == 'docs'
+Requires-Dist: sphinx-lint>=0.9; extra == 'docs'
+Requires-Dist: sphinx>=7.3; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# gamesheet-sdk-py
+
+> **Unofficial** Python SDK and command-line interface for the
+> [GameSheet Inc.](https://gamesheet.com) platform.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue.svg)](https://www.python.org/downloads/)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/bdperkin/gamesheet-sdk-py/main.svg)](https://results.pre-commit.ci/latest/github/bdperkin/gamesheet-sdk-py/main)
+
+## ⚠️ Disclaimer
+
+This project is **not affiliated with, endorsed by, or sponsored by GameSheet Inc.**
+GameSheet Inc. does not publish a public REST/GraphQL API for the operations this
+SDK covers. Where a native API is absent, this library **automates the GameSheet
+WebUI** (using a combination of HTTP requests, HTML parsing, and headless-browser
+automation) in order to perform routine tasks programmatically.
+
+Because this approach depends on the structure of a third-party web interface,
+**it may break without warning** whenever GameSheet ships UI changes. Always
+review the project's CHANGELOG before upgrading in production.
+
+Use of this software must comply with the GameSheet Inc. Terms of Service. You
+are responsible for any automation you perform against accounts you control.
+
+## Features
+
+- Pythonic wrappers over common GameSheet WebUI workflows
+- A `gamesheet-sdk-py` command-line interface for one-off scripting and shell pipelines
+- Typed (PEP 561) — ships a `py.typed` marker for static analysis
+- First-class support for headless automation via [Playwright](https://playwright.dev/python/)
+
+## Installation
+
+```bash
+pip install gamesheet-sdk-py
+
+# Playwright browser binaries are required for headless WebUI flows:
+python -m playwright install chromium
+```
+
+### From source
+
+```bash
+git clone https://github.com/bdperkin/gamesheet-sdk-py.git
+cd gamesheet-sdk-py
+pip install -e ".[dev]"
+python -m playwright install chromium
+```
+
+## Quick start
+
+```python
+from gamesheet_sdk import __version__
+
+print(__version__)
+```
+
+```bash
+gamesheet-sdk-py --help
+```
+
+## Project layout
+
+```
+gamesheet-sdk-py/
+├── src/gamesheet_sdk/   # library source
+├── tests/                  # pytest suite
+├── docs/                   # additional documentation
+├── pyproject.toml          # PEP 621 metadata + Hatch build
+├── .pre-commit-config.yaml # hooks run locally and on pre-commit.ci
+└── LICENSE                 # MIT
+```
+
+## Development
+
+```bash
+# 1. Create an isolated environment
+python -m venv .venv && source .venv/bin/activate
+
+# 2. Install with dev extras
+pip install -e ".[dev]"
+
+# 3. Install hook scripts
+pre-commit install
+
+# 4. Run the test suite
+pytest
+
+# 5. Run all hooks against the repo
+pre-commit run --all-files
+```
+
+## Contributing
+
+Issues and pull requests are welcome. Please run `pre-commit run --all-files`
+and `pytest` before opening a PR.
+
+## License
+
+Distributed under the terms of the [MIT License](LICENSE).
+© 2026 bdperkin.

gamesheet_sdk_py-0.0.1a1/README.md

@@ -0,0 +1,101 @@
+# gamesheet-sdk-py
+
+> **Unofficial** Python SDK and command-line interface for the
+> [GameSheet Inc.](https://gamesheet.com) platform.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue.svg)](https://www.python.org/downloads/)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/bdperkin/gamesheet-sdk-py/main.svg)](https://results.pre-commit.ci/latest/github/bdperkin/gamesheet-sdk-py/main)
+
+## ⚠️ Disclaimer
+
+This project is **not affiliated with, endorsed by, or sponsored by GameSheet Inc.**
+GameSheet Inc. does not publish a public REST/GraphQL API for the operations this
+SDK covers. Where a native API is absent, this library **automates the GameSheet
+WebUI** (using a combination of HTTP requests, HTML parsing, and headless-browser
+automation) in order to perform routine tasks programmatically.
+
+Because this approach depends on the structure of a third-party web interface,
+**it may break without warning** whenever GameSheet ships UI changes. Always
+review the project's CHANGELOG before upgrading in production.
+
+Use of this software must comply with the GameSheet Inc. Terms of Service. You
+are responsible for any automation you perform against accounts you control.
+
+## Features
+
+- Pythonic wrappers over common GameSheet WebUI workflows
+- A `gamesheet-sdk-py` command-line interface for one-off scripting and shell pipelines
+- Typed (PEP 561) — ships a `py.typed` marker for static analysis
+- First-class support for headless automation via [Playwright](https://playwright.dev/python/)
+
+## Installation
+
+```bash
+pip install gamesheet-sdk-py
+
+# Playwright browser binaries are required for headless WebUI flows:
+python -m playwright install chromium
+```
+
+### From source
+
+```bash
+git clone https://github.com/bdperkin/gamesheet-sdk-py.git
+cd gamesheet-sdk-py
+pip install -e ".[dev]"
+python -m playwright install chromium
+```
+
+## Quick start
+
+```python
+from gamesheet_sdk import __version__
+
+print(__version__)
+```
+
+```bash
+gamesheet-sdk-py --help
+```
+
+## Project layout
+
+```
+gamesheet-sdk-py/
+├── src/gamesheet_sdk/   # library source
+├── tests/                  # pytest suite
+├── docs/                   # additional documentation
+├── pyproject.toml          # PEP 621 metadata + Hatch build
+├── .pre-commit-config.yaml # hooks run locally and on pre-commit.ci
+└── LICENSE                 # MIT
+```
+
+## Development
+
+```bash
+# 1. Create an isolated environment
+python -m venv .venv && source .venv/bin/activate
+
+# 2. Install with dev extras
+pip install -e ".[dev]"
+
+# 3. Install hook scripts
+pre-commit install
+
+# 4. Run the test suite
+pytest
+
+# 5. Run all hooks against the repo
+pre-commit run --all-files
+```
+
+## Contributing
+
+Issues and pull requests are welcome. Please run `pre-commit run --all-files`
+and `pytest` before opening a PR.
+
+## License
+
+Distributed under the terms of the [MIT License](LICENSE).
+© 2026 bdperkin.

gamesheet_sdk_py-0.0.1a1/docs/conf.py

@@ -0,0 +1,143 @@
+"""Sphinx configuration for the gamesheet-sdk-py documentation."""
+
+from __future__ import annotations
+
+from importlib import metadata
+
+# -- Project information -----------------------------------------------------
+project = "gamesheet-sdk-py"
+author = "bdperkin"
+copyright = f"2026, {author}"
+release = metadata.version("gamesheet-sdk-py")
+version = ".".join(release.split(".")[:2])
+
+# -- General configuration ---------------------------------------------------
+extensions = [
+    # API documentation
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    # Cross-referencing
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosectionlabel",
+    # Quality
+    "sphinx.ext.doctest",
+    "sphinx.ext.coverage",
+    "sphinx.ext.todo",
+    "sphinx.ext.duration",
+    # Markdown + UI
+    "myst_parser",
+    "sphinx_copybutton",
+    "sphinx_design",
+    # CLI documentation
+    "sphinxarg.ext",
+]
+
+source_suffix = {
+    ".md": "markdown",
+    ".rst": "restructuredtext",
+}
+master_doc = "index"
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_autosummary"]
+templates_path = ["_templates"]
+
+# -- Automatic API documentation --------------------------------------------
+autosummary_generate = True
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+    "member-order": "bysource",
+}
+autodoc_typehints = "description"
+autodoc_typehints_description_target = "documented_params"
+autoclass_content = "both"
+
+# -- Napoleon (Google / NumPy docstrings) -----------------------------------
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+napoleon_use_rtype = False
+
+# -- Cross-referencing ------------------------------------------------------
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "requests": ("https://requests.readthedocs.io/en/latest/", None),
+    "bs4": ("https://www.crummy.com/software/BeautifulSoup/bs4/doc/", None),
+    "pydantic": ("https://docs.pydantic.dev/latest/", None),
+    "click": ("https://click.palletsprojects.com/en/stable/", None),
+}
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth = 3
+
+# -- MyST (Markdown) --------------------------------------------------------
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "fieldlist",
+    "tasklist",
+    "linkify",
+    "substitution",
+    "attrs_inline",
+    "attrs_block",
+]
+myst_heading_anchors = 3
+
+# -- TODOs ------------------------------------------------------------------
+todo_include_todos = True
+
+# -- HTML output (Furo theme) -----------------------------------------------
+html_theme = "furo"
+html_title = f"{project} {release}"
+html_static_path = ["_static"]
+html_theme_options = {
+    "source_repository": "https://github.com/bdperkin/gamesheet-sdk-py/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "navigation_with_keys": True,
+    "top_of_page_buttons": ["view", "edit"],
+}
+html_show_sourcelink = True
+html_copy_source = True
+
+# -- EPUB output ------------------------------------------------------------
+epub_show_urls = "footnote"
+epub_basename = project
+
+# -- Man-page output --------------------------------------------------------
+man_pages = [
+    (
+        "cli",
+        "gamesheet-sdk-py",
+        "Unofficial CLI for the GameSheet Inc. platform",
+        [author],
+        1,
+    ),
+]
+
+# -- LaTeX / PDF output -----------------------------------------------------
+latex_engine = "pdflatex"
+latex_documents = [
+    (
+        master_doc,
+        f"{project}.tex",
+        f"{project} Documentation",
+        author,
+        "manual",
+    ),
+]
+latex_elements = {
+    "papersize": "letterpaper",
+    "pointsize": "11pt",
+}
+
+# -- Link-check options -----------------------------------------------------
+linkcheck_retries = 2
+linkcheck_timeout = 15
+linkcheck_ignore = [
+    # Anchors on third-party sites we don't control:
+    r"^https?://github\.com/.*#",
+]

gamesheet_sdk_py-0.0.1a1/docs/explanation/diataxis.md

@@ -0,0 +1,48 @@
+# Why these docs are organized into four quadrants
+
+This project's documentation is structured following the
+[Diátaxis framework](https://diataxis.fr/), authored by Daniele Procida.
+
+Diátaxis observes that effective technical documentation serves four
+*distinct* user needs that cannot be merged without harm:
+
+|                      | **Practical steps** | **Theoretical knowledge** |
+| -------------------- | ------------------- | ------------------------- |
+| **Study (learning)** | Tutorials           | Explanation               |
+| **Work (doing)**     | How-to guides       | Reference                 |
+
+When you sit down to write something for these docs, the first question is
+*which of the four quadrants does it belong in?* — and if the answer is
+"more than one," that's usually a signal that the content needs to be split.
+
+## Why this matters
+
+When a single page tries to teach, demonstrate, document, and explain all at
+once, it does each of those jobs badly. A user who came for a quick lookup
+has to wade through pedagogy; a learner gets dropped into reference material
+before they have context.
+
+Splitting by *user need* keeps each page focused. The cross-references
+between quadrants then carry the cognitive load instead of the prose.
+
+## How to choose a quadrant
+
+Ask yourself, *about the reader who will land on this page:*
+
+- Are they **trying to learn the SDK** by following along? →
+  {doc}`../tutorials/index`
+- Do they have **a specific task in mind** and need a recipe? →
+  {doc}`../how-to/index`
+- Do they need to **look something up** while doing their work? →
+  {doc}`../reference/index`
+- Do they want **deeper understanding** of why something is the way it is?
+  → this section ({doc}`index`)
+
+If two of those are tied, the content probably needs to be two pages, one
+in each quadrant, cross-linking to the other.
+
+## Further reading
+
+- [diataxis.fr](https://diataxis.fr/) — the canonical introduction
+- [The four kinds of documentation, and why](https://documentation.divio.com/)
+  — an earlier write-up by the same author

gamesheet_sdk_py-0.0.1a1/docs/explanation/index.md

@@ -0,0 +1,30 @@
+# Explanation
+
+> Explanation, or discussion, **clarifies and illuminates a particular topic**.
+> It broadens the documentation's coverage of a topic.
+>
+> — [diataxis.fr/explanation](https://diataxis.fr/explanation/)
+
+Explanation is **understanding-oriented**. It exists to broaden context — why
+choices were made, how the system behaves under the hood, what assumptions
+constrain the design. It does not give step-by-step instructions and it does
+not list APIs.
+
+## Authoring guidance
+
+When adding an explanation to this section:
+
+- **Free yourself from a concrete task.** Discuss the topic in its own right.
+- **Connect ideas.** Cross-reference {doc}`../reference/index` for *what*
+  and {doc}`../how-to/index` for *how*.
+- **Acknowledge trade-offs.** Explanation is the place to say "we don't do
+  X because Y."
+- **Welcome multiple perspectives.** Unlike reference, explanation can hold
+  competing views and let the reader weigh them.
+
+```{toctree}
+:maxdepth: 1
+
+why-webui-automation
+diataxis
+```