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.
