fungo 1.0.0__tar.gz

fungo-1.0.0/.flake8

@@ -0,0 +1,8 @@
+[flake8]
+docstring-convention = google
+exclude = test*.py,dev
+extend-select = TC
+ignore = E203,W503,D212,TC003,E800
+max-complexity = 10
+max-cognitive-complexity = 10
+max-line-length = 88

fungo-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Install Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Sync dependencies
+        run: uv sync --python ${{ matrix.python-version }} --all-extras --dev
+
+      - name: Lint (ruff check)
+        run: uv run ruff check .
+
+      - name: Format check (ruff format)
+        run: uv run ruff format --check .
+
+      - name: Type-check (strict)
+        run: uv run mypy
+
+      - name: Test (offline) with coverage gate
+        run: uv run pytest --cov=fungo --cov-report=term-missing --cov-fail-under=100
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Smoke installed wheel
+        run: |
+          python -m venv /tmp/fungo-smoke
+          /tmp/fungo-smoke/bin/python -m pip install dist/*.whl
+          /tmp/fungo-smoke/bin/python -c "import fungo; assert fungo.__version__ == '1.0.0'"
+          /tmp/fungo-smoke/bin/fungo --help

fungo-1.0.0/.gitignore

@@ -0,0 +1,126 @@
+# macOS
+.DS_Store
+.vscode
+.idea
+
+# Data
+*.csv
+!data/*/*.csv
+dev/
+
+# 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
+.hypothesis/
+.pytest_cache/
+cassettes/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# iPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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/

fungo-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-toml
+        types: [toml]
+      - id: check-yaml
+        types: [yaml]
+      - id: end-of-file-fixer
+        types: [text]
+        stages: [pre-commit, pre-push, manual]
+      - id: trailing-whitespace
+        types: [text]
+        stages: [pre-commit, pre-push, manual]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.16.0
+    hooks:
+      - id: mypy
+        pass_filenames: false

fungo-1.0.0/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+
+### Added
+
+- `fungo.mlb`, a typed pass-through wrapper surface for MLB Stats API
+  endpoints.
+- Baseball Savant leaderboard registry with typed wrappers and explicit
+  season-parameter handling for bat-tracking boards.
+- Statcast pitch-level search helpers for games, teams, matchups, and pitcher
+  arsenal aggregation.
+- Nathan-style derived spin physics columns via `fungo.statcast.physics`.
+- Chadwick Bureau player lookup and ID converters with local cache refresh.
+- `fungo` CLI with lookup, search, leaderboard, and MLB subcommands.
+- Optional pandas/polars DataFrame conversion through `fungo.to_frame`.
+- `py.typed` marker for inline type annotations.
+- GitHub Actions CI across Python 3.12-3.14 with ruff, mypy, offline pytest
+  coverage, package build, and wheel install smoke tests.
+
+### Changed
+
+- Packaged with Hatchling, uv, PEP 621 metadata, and runtime-only extras.
+- The public API is organized around `fungo.statcast`, `fungo.mlb`, and
+  `fungo.lookup`.
+- Live tests are opt-in; default test runs are fully offline.
+
+### Removed
+
+- Removed pre-1.0 experimental modules: `fungo.download`, `fungo.field`,
+  `fungo.query`, `fungo.statcast.analysis`, `fungo.statcast.base`,
+  `fungo.statcast.leaderboard`, and `fungo.statcast.query`.
+
+### Notes
+
+- `fungo.statcast.get_top_performers` raises `SavantError` because Baseball
+  Savant currently serves that page with an empty inline JSON payload and
+  renders the cards directly in HTML.

fungo-1.0.0/CLAUDE.md

@@ -0,0 +1,80 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What this is
+
+`fungo` acquires baseball data from public web sources: Baseball Savant (Statcast pitch-level search + ~42 leaderboards), the MLB Stats API (`statsapi.mlb.com`), and the Chadwick Bureau player-ID register.
+
+The **core is stdlib-only** (no third-party runtime deps — `dependencies = []` in `pyproject.toml`). It returns **raw data**, not DataFrames:
+
+- CSV endpoints (Statcast search, most leaderboards, lookup) return `list[dict]`; **every value is a string** (`""` for empty cells). Callers cast themselves.
+- JSON endpoints (the MLB Stats API, HTML-backed Savant leaderboards) return the raw `dict` / `list` exactly as the source produced it.
+
+DataFrame conversion is **optional and explicit** via `fungo.frame.to_frame(rows, backend="polars" | "pandas")`, behind extras. `rich` progress bars are also an opt-in extra. The library never writes to stdout unless `progress=True` is passed.
+
+## Commands
+
+- Env / install (Python `>=3.12`): `uv venv` then `uv pip install -e ".[dev]"`.
+- Lint / format: `uv run ruff check .` and `uv run ruff format .` (line length 88; lint selects `E,F,W,I,UP,B,SIM,C4,RUF`).
+- Types: `uv run mypy src` (strict mode; `files = ["src"]`).
+- Tests: `uv run pytest`. Tests are **offline by default** — `addopts = "-m 'not live'"` deselects network tests. Live tests are marked `@pytest.mark.live`; run them with `uv run pytest -m live`. Run one test: `uv run pytest tests/statcast/test_leaderboards.py::test_name`.
+
+### CLI
+
+A single console script, `fungo`, with four subcommands (registered via `[project.scripts]` in `pyproject.toml`). `cli.py` has no `__main__` guard and there is no `__main__.py`, so **`python -m fungo` does not work** — invoke the installed `fungo` script.
+
+```
+fungo lookup [--name NAME | --mlbam ID] [--no-mlb-only] [-o OUT] [--format {csv,json}]
+fungo search --start YYYY-MM-DD --end YYYY-MM-DD [--player-type pitcher|batter] [--player-id ID] [--level mlb|milb] [--<field>=val ...]
+fungo leaderboard SLUG [--season YEARS] [--type T] [--player-id ID] [--<field>=val ...]   |   fungo leaderboard --list [--category C]
+fungo mlb FUNCTION [--<field>=val ...]   |   fungo mlb --list
+```
+
+- `--format` defaults to `csv` for `lookup`/`search`/`leaderboard` and `json` for `mlb`. CSV rendering requires a `list[dict]`; non-tabular results error and ask for `--format json`.
+- `search` and `leaderboard`/`mlb` accept arbitrary `--field=value` (or `--field value`) passthrough via `parse_known_args` → `_parse_extras`. **Only `search`** pipe-joins comma-separated values (`--pitch-type=FF,SL` → `FF|SL`, Savant's convention); the others pass values verbatim.
+- `--season 2023,2024` becomes a `list[int]`, valid only for the bat-tracking season-array / camelCase boards (see below). Passing a multi-year value to any other (`int`-format) board raises `ValidationError` — `_emit_year` fails loud rather than silently sending a mangled `year=`.
+
+## Architecture
+
+Two layers: a **stdlib generic engine** and a **source-specific specialization** on top of it.
+
+### Generic engine
+
+- `http.py` — stdlib transport. `request_bytes` (urlencode with `safe="|"` so pipe-delimited params survive, `doseq=True` so list values become repeated keys, drops `None` values, exponential-backoff retry on 5xx/network, raises `RequestError` on 4xx or exhausted retries). `request_json` = `request_bytes` + JSON decode. `parse_csv` (BOM-aware via `utf-8-sig`, preserves empty strings). `map_concurrent` (bounded `ThreadPoolExecutor`, preserves input order, optional inter-submit `delay`, opt-in silent `rich` progress). Uses PEP-695 generics.
+- `exceptions.py` — `FungoError` base; `RequestError`, `SavantError`, `MLBStatsError`, and `ValidationError(value, field_name, valid_values=None)` (also a `ValueError`; emits a `difflib` "did you mean?" suggestion). Reuse these — don't raise bare `ValueError`.
+- `constants.py` — `PITCH_TYPES`, `TEAMS` (enriched club metadata), and resolvers `resolve_team` / `resolve_pitch_type` / `resolve_hand` (raise `ValidationError` on a miss).
+- `lookup.py` — Chadwick register cross-reference (MLBAM ↔ FanGraphs ↔ Baseball-Reference ↔ Retrosheet). Downloads the ~6 MB register (16 shards) on first use and caches it under the stdlib user cache dir (`$XDG_CACHE_HOME` or `~/.cache` → `fungo/chadwick_people.csv`). `lookup(...)`, `refresh()`, and `mlbam_to_*` / `*_to_mlbam` converters.
+- `frame.py` — optional `to_frame(rows, backend)`; imports the backend lazily and raises an actionable `ImportError` if the extra isn't installed.
+
+### Statcast specialization (`statcast/`)
+
+- `search.py` — `statcast_search(start_date, end_date, ...)` and the convenience wrappers `search_game`, `search_matchup`, `search_team`, plus `aggregate_pitcher_arsenal` / `get_pitcher_arsenal`. `fetch_csv` adds Savant-specific **HTML-vs-CSV detection**: Savant serves an HTML page with HTTP 200 (not a 4xx) when given params it can't fulfill — that's caught and raised as `SavantError`. `statcast_search` returns **raw rows**; it does NOT add physics columns.
+- `leaderboards.py` — the `LEADERBOARDS` registry (~42 entries), the `year_format`-aware `fetch_leaderboard` + registry-checked `get_leaderboard`, ~33 typed CSV wrappers (`get_exit_velocity_barrels`, `get_expected_statistics`, `get_pitch_movement`, `get_poptime`, `get_catcher_framing`, …), 4 HTML-backed wrappers (`get_park_factors`, `get_hot_stove`, `get_top_performers`, `get_rolling_windows`, via `fetch_html_json`), and the introspection helpers `list_leaderboards` / `describe_leaderboard`. **To add or change a Statcast field, edit the registry dict in `leaderboards.py`** — that's the single source of truth.
+- `physics.py` — Nathan (2021) spin-physics derived columns (stdlib `math` only). `add_spin_columns(rows)` is **opt-in** — call it explicitly on search output; nothing applies it automatically. `compute_row`, `axis_to_clock`, `DERIVED_COLUMNS`.
+
+### MLB Stats API (`mlb/`)
+
+A pure pass-through port (~90 functions across `stats_api`, `people`, `teams`, `games`, `stats`, `misc`, `discovery`, `constants`). Every function returns the raw JSON `dict`/`list`. `mlb_api(path, params)` is the low-level escape hatch; the typed functions (`get_person`, `get_schedule`, `get_roster`, `get_stats`, …) wrap specific endpoints. `mlb.__all__` lists every public function (the CLI's `fungo mlb --list` reads it).
+
+## The two non-obvious things (the library's hard-won value)
+
+### 1. Bat-tracking boards ignore `year=` (the `year_format` mechanism)
+
+The three Hawk-Eye bat-tracking boards — `bat-tracking`, `bat-tracking/swing-path-attack-angle`, `bat-tracking/swing-timing-miss-distance` — **silently return the current season if you pass the standard `year=` param.** `_emit_year` in `leaderboards.py` branches per slug on the registry's `year_format`:
+
+- `int` / `special` → `year=<str>` (`special`, e.g. active-spin, wants a composite `"2024_spin-based"` — build it with `active_spin_year`).
+- `camelCase_season` → `seasonStart` + `seasonEnd`. A `(start, end)` tuple/list is a **contiguous range**; multi-year returns **one aggregated row per player across the span, with no year column** (`bat-tracking`, `swing-path-attack-angle`).
+- `season_array` → repeated `season[]` keys (this is why `request_bytes` uses `doseq=True`). A list is a **true multi-select**; multi-year returns **one row per player per year, with a year column** (`swing-timing-miss-distance`).
+
+The tuple-vs-list / range-vs-array distinction is the whole point — it dictates whether you get a year column. Also: `swing-timing-miss-distance` uses the plain `min` threshold, not `minSwings`, and `miss_distance` is in inches.
+
+### 2. Day-chunking defends the ~30k-row cap
+
+Savant silently truncates responses at ~30,000 rows (`MAX_ROWS_PER_QUERY`). `statcast_search` auto-chunks any range longer than 5 days into 1-day requests, fanned through `map_concurrent` (bounded pool, 1s politeness delay between submits), and flattens per-day results in date order. Pipe-delimited multi-value filters must **not** be URL-encoded — `request_bytes` sets `safe="|"` for exactly this.
+
+## Conventions
+
+- New sources follow the same shape: a stdlib fetch on `http.py`, source-specific quirks (HTML detection, param emission) isolated in the source module, raw `list[dict]`/JSON out, DataFrame conversion left to `to_frame`.
+- Fail loud — let stdlib/transport exceptions propagate; raise the typed `ValidationError`/`SavantError`/`MLBStatsError`/`RequestError` for input and source problems rather than bare exceptions or silent fallbacks.
+- Keep the core dependency-free; anything needing `polars`/`pandas`/`rich` is an optional extra, imported lazily at the call site.

fungo-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2022 Josh Hejka
+
+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.

fungo-1.0.0/MIGRATION.md

@@ -0,0 +1,41 @@
+# Fungo 1.0 Migration Notes
+
+Fungo 1.0 is a cleanup release that stabilizes the package around explicit
+subpackages instead of the older experimental module layout.
+
+## Public Surface
+
+Use these imports:
+
+- `fungo.statcast` for Baseball Savant pitch search, leaderboards, and derived
+  spin physics.
+- `fungo.mlb` for MLB Stats API pass-through wrappers.
+- `fungo.lookup` for Chadwick Bureau player ID lookup.
+- `fungo.to_frame` for optional pandas/polars conversion.
+
+## Removed Pre-1.0 Modules
+
+The following modules were removed:
+
+- `fungo.download`
+- `fungo.field`
+- `fungo.query`
+- `fungo.statcast.analysis`
+- `fungo.statcast.base`
+- `fungo.statcast.leaderboard`
+- `fungo.statcast.query`
+
+Use these replacements:
+
+- `fungo.statcast.search` for pitch-level Savant search.
+- `fungo.statcast.leaderboards` for Savant leaderboard wrappers.
+- `fungo.statcast.physics` for derived spin/movement columns.
+- `fungo.mlb` for MLB Stats API endpoints.
+
+## Known Savant Limitation
+
+`fungo.statcast.get_top_performers` raises `SavantError` in 1.0 because
+Baseball Savant currently serves the page with an empty inline JSON payload
+(`var data = {};`) and renders the cards directly in HTML. Returning `{}` would
+hide upstream drift, so the wrapper fails loudly until Savant exposes a stable
+machine-readable payload again.