bluealliance 0.1.0__tar.gz

bluealliance-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

bluealliance-0.1.0/.gitignore

@@ -0,0 +1,181 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.vscode/
+# 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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

bluealliance-0.1.0/LICENSE

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

bluealliance-0.1.0/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: bluealliance
+Version: 0.1.0
+Summary: Python client for The Blue Alliance API v3 — typed, schema-validated, zero boilerplate.
+Project-URL: Repository, https://github.com/Kaique-Sique/BlueAlliancePy
+License: MIT License
+        
+        Copyright (c) 2026 Kaique
+        
+        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: api-client,first-robotics,frc,tba,the-blue-alliance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.7
+Requires-Dist: requests>=2.32
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# BlueAlliancePy
+
+Python client for [The Blue Alliance](https://www.thebluealliance.com) API v3.
+Typed, schema-validated, zero boilerplate.
+
+Built for FRC Team 7563 (Megazord) scouting infrastructure.
+
+## Installation
+
+```bash
+pip install bluealliance
+```
+
+Or directly from the repository:
+
+```bash
+pip install git+https://github.com/Kaique-Sique/BlueAlliancePy.git
+```
+
+## Quick start
+
+Get your API key at https://www.thebluealliance.com/account.
+
+```python
+from bluealliance import TBACollector
+
+c = TBACollector("YOUR_TBA_KEY")
+
+# team profile
+team = c.team("frc7563")
+print(team.nickname, team.city)  # Megazord, Jundiaí
+
+# all teams at an event (typed, not raw dicts)
+for team in c.event_teams("2025spbra"):
+    print(team.team_number, team.nickname)
+
+# live rankings
+ranking = c.event_rankings("2025spbra")
+if ranking:
+    for entry in ranking.rankings[:5]:
+        print(entry.rank, entry.team_key, entry.record)
+
+# full event bundle in one call
+bundle = c.event_bundle("2025spbra")
+print(bundle.event.name)
+print(f"{len(bundle.teams)} teams, {len(bundle.matches)} matches")
+
+# 2025 Reefscape score breakdown already parsed
+for match, bd in c.event_matches_2025("2025spbra"):
+    if bd:
+        coral = bd.red.autoCoralCount + bd.red.teleopCoralCount
+        print(match.key, "red coral:", coral, "endgame:", bd.red.endGameRobot1)
+```
+
+## Three layers
+
+| Layer | Import | What it does |
+|---|---|---|
+| `TBAClient` | `from bluealliance import TBAClient` | Raw HTTP — returns `dict`/`list`. One method per TBA endpoint (84 total). |
+| `TBACollector` | `from bluealliance import TBACollector` | Typed — wraps every client method to return Pydantic models instead of dicts. Handles pagination automatically. |
+| Schemas | `from bluealliance import Team, Match, Event` | Pydantic v2 models. Use `Model.model_validate(raw)` if you already have a dict. |
+
+You can mix layers freely — `TBACollector` for most work, `TBAClient` when you need the raw payload for something not covered by the schemas.
+
+## Low-level client
+
+```python
+from bluealliance import TBAClient
+
+client = TBAClient("YOUR_TBA_KEY")
+
+# returns raw dict/list -- no Pydantic parsing
+raw = client.get_event_matches("2025spbra")
+raw_team = client.get_team("frc7563")
+```
+
+## Pydantic models directly
+
+```python
+from bluealliance.schemas import Team, Match, ScoreBreakdown2025, parse_score_breakdown_2025
+
+team = Team.model_validate(raw_dict)
+
+match = Match.model_validate(raw_match_dict)
+bd = parse_score_breakdown_2025(match.score_breakdown)
+if bd:
+    print(bd.red.totalPoints, bd.blue.endGameBargePoints)
+```
+
+## Available collector methods
+
+### Status
+- `c.status()` → `APIStatus`
+
+### Teams
+- `c.team(key)` → `Team`
+- `c.team_simple(key)` → `TeamSimple`
+- `c.team_history(key)` → `TeamHistory`
+- `c.team_robots(key)` → `list[TeamRobot]`
+- `c.team_awards(key, year?)` → `list[Award]`
+- `c.team_media(key, year)` → `list[MediaBase]`
+- `c.team_events(key, year?)` → `list[Event]`
+- `c.team_matches(key, year)` → `list[Match]`
+- `c.team_event_matches(key, event_key)` → `list[Match]`
+- `c.team_event_status(key, event_key)` → `TeamEventStatus | None`
+- `c.team_season_summary(key, year)` → `TeamSeasonSummary`
+- `c.all_teams_by_year(year)` → `list[Team]` *(auto-paginates)*
+
+### Events
+- `c.events(year)` → `list[Event]`
+- `c.event(key)` → `Event`
+- `c.event_teams(key)` → `list[Team]`
+- `c.event_matches(key)` → `list[Match]`
+- `c.event_matches_2025(key)` → `list[tuple[Match, ScoreBreakdown2025 | None]]`
+- `c.event_rankings(key)` → `EventRanking | None`
+- `c.event_oprs(key)` → `EventOPRs | None`
+- `c.event_alliances(key)` → `list[EliminationAlliance] | None`
+- `c.event_awards(key)` → `list[Award]`
+- `c.event_teams_statuses(key)` → `dict[str, TeamEventStatus | None]`
+- `c.event_bundle(key)` → `EventBundle`
+
+### Matches
+- `c.match(key)` → `Match`
+- `c.match_2025(key)` → `tuple[Match, ScoreBreakdown2025 | None]`
+- `c.match_zebra(key)` → `Zebra`
+
+### Districts
+- `c.districts(year)` → `list[District]`
+- `c.district_rankings(key)` → `list[DistrictRanking] | None`
+- `c.district_advancement(key)` → `dict[str, DistrictAdvancement] | None`
+
+### Regional (2025+)
+- `c.regional_advancement(year)` → `dict[str, RegionalAdvancement] | None`
+- `c.regional_rankings(year)` → `list[RegionalRanking] | None`
+
+### Insights
+- `c.leaderboards(year)` → `list[LeaderboardInsight]`
+- `c.insights_v2(year, category?)` → `list[InsightV2...]`
+
+## Requirements
+
+- Python 3.11+
+- `requests >= 2.32`
+- `pydantic >= 2.7`

bluealliance-0.1.0/README.md

@@ -0,0 +1,144 @@
+# BlueAlliancePy
+
+Python client for [The Blue Alliance](https://www.thebluealliance.com) API v3.
+Typed, schema-validated, zero boilerplate.
+
+Built for FRC Team 7563 (Megazord) scouting infrastructure.
+
+## Installation
+
+```bash
+pip install bluealliance
+```
+
+Or directly from the repository:
+
+```bash
+pip install git+https://github.com/Kaique-Sique/BlueAlliancePy.git
+```
+
+## Quick start
+
+Get your API key at https://www.thebluealliance.com/account.
+
+```python
+from bluealliance import TBACollector
+
+c = TBACollector("YOUR_TBA_KEY")
+
+# team profile
+team = c.team("frc7563")
+print(team.nickname, team.city)  # Megazord, Jundiaí
+
+# all teams at an event (typed, not raw dicts)
+for team in c.event_teams("2025spbra"):
+    print(team.team_number, team.nickname)
+
+# live rankings
+ranking = c.event_rankings("2025spbra")
+if ranking:
+    for entry in ranking.rankings[:5]:
+        print(entry.rank, entry.team_key, entry.record)
+
+# full event bundle in one call
+bundle = c.event_bundle("2025spbra")
+print(bundle.event.name)
+print(f"{len(bundle.teams)} teams, {len(bundle.matches)} matches")
+
+# 2025 Reefscape score breakdown already parsed
+for match, bd in c.event_matches_2025("2025spbra"):
+    if bd:
+        coral = bd.red.autoCoralCount + bd.red.teleopCoralCount
+        print(match.key, "red coral:", coral, "endgame:", bd.red.endGameRobot1)
+```
+
+## Three layers
+
+| Layer | Import | What it does |
+|---|---|---|
+| `TBAClient` | `from bluealliance import TBAClient` | Raw HTTP — returns `dict`/`list`. One method per TBA endpoint (84 total). |
+| `TBACollector` | `from bluealliance import TBACollector` | Typed — wraps every client method to return Pydantic models instead of dicts. Handles pagination automatically. |
+| Schemas | `from bluealliance import Team, Match, Event` | Pydantic v2 models. Use `Model.model_validate(raw)` if you already have a dict. |
+
+You can mix layers freely — `TBACollector` for most work, `TBAClient` when you need the raw payload for something not covered by the schemas.
+
+## Low-level client
+
+```python
+from bluealliance import TBAClient
+
+client = TBAClient("YOUR_TBA_KEY")
+
+# returns raw dict/list -- no Pydantic parsing
+raw = client.get_event_matches("2025spbra")
+raw_team = client.get_team("frc7563")
+```
+
+## Pydantic models directly
+
+```python
+from bluealliance.schemas import Team, Match, ScoreBreakdown2025, parse_score_breakdown_2025
+
+team = Team.model_validate(raw_dict)
+
+match = Match.model_validate(raw_match_dict)
+bd = parse_score_breakdown_2025(match.score_breakdown)
+if bd:
+    print(bd.red.totalPoints, bd.blue.endGameBargePoints)
+```
+
+## Available collector methods
+
+### Status
+- `c.status()` → `APIStatus`
+
+### Teams
+- `c.team(key)` → `Team`
+- `c.team_simple(key)` → `TeamSimple`
+- `c.team_history(key)` → `TeamHistory`
+- `c.team_robots(key)` → `list[TeamRobot]`
+- `c.team_awards(key, year?)` → `list[Award]`
+- `c.team_media(key, year)` → `list[MediaBase]`
+- `c.team_events(key, year?)` → `list[Event]`
+- `c.team_matches(key, year)` → `list[Match]`
+- `c.team_event_matches(key, event_key)` → `list[Match]`
+- `c.team_event_status(key, event_key)` → `TeamEventStatus | None`
+- `c.team_season_summary(key, year)` → `TeamSeasonSummary`
+- `c.all_teams_by_year(year)` → `list[Team]` *(auto-paginates)*
+
+### Events
+- `c.events(year)` → `list[Event]`
+- `c.event(key)` → `Event`
+- `c.event_teams(key)` → `list[Team]`
+- `c.event_matches(key)` → `list[Match]`
+- `c.event_matches_2025(key)` → `list[tuple[Match, ScoreBreakdown2025 | None]]`
+- `c.event_rankings(key)` → `EventRanking | None`
+- `c.event_oprs(key)` → `EventOPRs | None`
+- `c.event_alliances(key)` → `list[EliminationAlliance] | None`
+- `c.event_awards(key)` → `list[Award]`
+- `c.event_teams_statuses(key)` → `dict[str, TeamEventStatus | None]`
+- `c.event_bundle(key)` → `EventBundle`
+
+### Matches
+- `c.match(key)` → `Match`
+- `c.match_2025(key)` → `tuple[Match, ScoreBreakdown2025 | None]`
+- `c.match_zebra(key)` → `Zebra`
+
+### Districts
+- `c.districts(year)` → `list[District]`
+- `c.district_rankings(key)` → `list[DistrictRanking] | None`
+- `c.district_advancement(key)` → `dict[str, DistrictAdvancement] | None`
+
+### Regional (2025+)
+- `c.regional_advancement(year)` → `dict[str, RegionalAdvancement] | None`
+- `c.regional_rankings(year)` → `list[RegionalRanking] | None`
+
+### Insights
+- `c.leaderboards(year)` → `list[LeaderboardInsight]`
+- `c.insights_v2(year, category?)` → `list[InsightV2...]`
+
+## Requirements
+
+- Python 3.11+
+- `requests >= 2.32`
+- `pydantic >= 2.7`

bluealliance-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bluealliance"
+version = "0.1.0"
+description = "Python client for The Blue Alliance API v3 — typed, schema-validated, zero boilerplate."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.11"
+keywords = ["frc", "first-robotics", "the-blue-alliance", "tba", "api-client"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "requests>=2.32",
+    "pydantic>=2.7",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov",
+    "ruff",
+    "mypy",
+]
+
+[project.urls]
+Repository = "https://github.com/Kaique-Sique/BlueAlliancePy"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bluealliance"]
+artifacts = ["src/bluealliance/py.typed"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.mypy]
+python_version = "3.11"
+strict = true