puckapi 0.1.0__tar.gz

puckapi-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.egg-info/
+.pytest_cache/
+.venv/
+dist/
+build/

puckapi-0.1.0/LICENSE

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

puckapi-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.5
+Name: puckapi
+Version: 0.1.0
+Summary: Python client for the PuckAPI NHL data API. No dependencies.
+Project-URL: Homepage, https://puckapi.com
+Project-URL: Documentation, https://puckapi.com/docs
+Project-URL: Repository, https://github.com/noahowsh/puckapi
+Project-URL: Sign up, https://puckapi.com/signup
+Author-email: PuckAPI <support@puckapi.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-client,betting,nhl,odds,player-props,puckapi,sports-data
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+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
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.5; extra == 'pandas'
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == 'test'
+Description-Content-Type: text/markdown
+
+# PuckAPI for Python
+
+Python client for the [PuckAPI](https://puckapi.com) NHL data API. It has no required dependencies (standard library only) and works on Python 3.9 and newer. Pandas is optional.
+
+## Install
+
+```bash
+pip install puckapi
+pip install "puckapi[pandas]"   # only if you want DataFrames
+```
+
+## Set your key
+
+Get a free key at https://puckapi.com/signup. Free accounts get 500 credits a month.
+
+```bash
+export PUCKAPI_API_KEY=your_key_here
+```
+
+```python
+from puckapi import Client
+
+client = Client()                      # reads PUCKAPI_API_KEY
+client = Client(api_key="your_key")    # or pass it in
+```
+
+## Examples
+
+### 1. Closing odds for a game
+
+`get_odds` returns one row per bookmaker and snapshot. Ask for the closing snapshot and load it into pandas.
+
+```python
+from puckapi import Client, to_dataframe
+
+client = Client()
+
+odds = client.get_odds(game_id="2026020080", snapshot_type="closing")
+df = to_dataframe(odds, key="odds")
+print(df[["bookmaker", "mlHome", "mlAway", "total"]])
+print("credits left:", client.last_credits_remaining)
+```
+
+### 2. Who played the most minutes (shift data)
+
+`get_shifts` returns every shift for every skater in a game, with start and end times.
+
+```python
+from puckapi import Client
+
+client = Client()
+
+shifts = client.get_shifts(game_id="2026020080", team="TOR")
+busiest = sorted(shifts["players"], key=lambda p: p["shift_seconds"], reverse=True)[:5]
+for p in busiest:
+    print(p["name"], p["shift_count"], "shifts,", p["shift_seconds"] // 60, "min")
+```
+
+### 3. A player's recent games
+
+Find a player id with `search_players`, then pull the game log.
+
+```python
+from puckapi import Client
+
+client = Client()
+
+match = client.search_players("Matthews", limit=1)["players"][0]
+log = client.get_player_game_log(match["id"], season="20252026", limit=5)
+print(match["name"], log)
+```
+
+## Credits
+
+Every method returns the `data` object from the response. After each call, `client.last_credits_used` and `client.last_credits_remaining` hold the counters from the `X-Credits-Used` and `X-Credits-Remaining` headers. Methods that take `estimate_only=True` return the price of a call without running or charging it.
+
+## Pandas
+
+```python
+from puckapi import to_dataframe
+
+df = to_dataframe(data)                # finds the main list in the response
+df = to_dataframe(data, key="rows")    # or name the list yourself
+```
+
+Nested fields become dotted columns. Install pandas separately or with `pip install "puckapi[pandas]"`.
+
+## Errors
+
+Every error is an `APIError` subclass, with the server's message and the HTTP status.
+
+| Exception | Status | Meaning |
+| --- | --- | --- |
+| `AuthError` | 401 | Missing, invalid or revoked key |
+| `InsufficientCreditsError` | 402 | Not enough credits for the call |
+| `NotFoundError` | 404 | The id or name does not exist |
+| `RateLimitError` | 429 | Too many requests; has `.retry_after` when the server sends it |
+| `APIError` | 400, 5xx | Bad arguments or a server problem |
+| `APIConnectionError` | none | No response (network or timeout) |
+
+```python
+from puckapi import Client, APIError, InsufficientCreditsError, RateLimitError
+
+client = Client()
+try:
+    data = client.list_teams()
+except InsufficientCreditsError:
+    print("Out of credits, top up at https://puckapi.com")
+except RateLimitError as exc:
+    print("Slow down, retry after", exc.retry_after)
+except APIError as exc:
+    print(exc.status_code, exc.message)
+```
+
+The client retries 429 and 5xx responses and connection failures up to 3 times with backoff, and honors `Retry-After`. Set `Client(max_retries=0)` to turn that off.
+
+If you see `CERTIFICATE_VERIFY_FAILED` on a python.org install for macOS, run the "Install Certificates.command" script that came with Python, or `pip install certifi` (the client uses it when present).
+
+## Options
+
+```python
+Client(
+    api_key=None,                          # defaults to $PUCKAPI_API_KEY
+    base_url="https://mcp.puckapi.com",           # point at another host
+    timeout=60.0,                          # seconds per request
+    max_retries=3,
+)
+```
+
+`client.call("tool_name", {"arg": "value"})` calls any tool by name, which helps when the API adds a tool before this package does.
+
+## Tools
+
+Method names match the API tool names. Arguments are keyword arguments; required ones can also be passed positionally. Each method's docstring lists its arguments (`help(client.list_teams)`).
+
+| Method | Credits | What it does |
+| --- | --- | --- |
+| `get_standings` | 2 | Standings |
+| `get_team_stats` | 5 | Team stats |
+| `list_teams` | 1 | List teams |
+| `get_games` | 5 | Games |
+| `get_schedule` | 2 | Schedule |
+| `get_game_detail` | 10 | Game detail |
+| `get_head_to_head` | 10 | Head to head |
+| `search_players` | 2 | Search players |
+| `get_player_stats` | 5 | Player stats |
+| `get_goalie_stats` | 5 | Goalie stats |
+| `get_skater_season_stats` | 5 | Skater season stats |
+| `get_player_game_log` | 5 | Player game log |
+| `get_odds` | 10 | Odds |
+| `get_line_movement` | 25 | Line movement |
+| `get_player_props` | 10 | Player props |
+| `get_prop_history` | 10 | Prop history |
+| `get_plays` | 10 | Plays |
+| `get_shot_map` | 10 | Shot map |
+| `get_shifts` | 10 | Shifts |
+| `get_situation_time` | 10 | Situation time |
+
+Full API reference: https://puckapi.com/docs
+
+## License
+
+MIT

puckapi-0.1.0/README.md

@@ -0,0 +1,163 @@
+# PuckAPI for Python
+
+Python client for the [PuckAPI](https://puckapi.com) NHL data API. It has no required dependencies (standard library only) and works on Python 3.9 and newer. Pandas is optional.
+
+## Install
+
+```bash
+pip install puckapi
+pip install "puckapi[pandas]"   # only if you want DataFrames
+```
+
+## Set your key
+
+Get a free key at https://puckapi.com/signup. Free accounts get 500 credits a month.
+
+```bash
+export PUCKAPI_API_KEY=your_key_here
+```
+
+```python
+from puckapi import Client
+
+client = Client()                      # reads PUCKAPI_API_KEY
+client = Client(api_key="your_key")    # or pass it in
+```
+
+## Examples
+
+### 1. Closing odds for a game
+
+`get_odds` returns one row per bookmaker and snapshot. Ask for the closing snapshot and load it into pandas.
+
+```python
+from puckapi import Client, to_dataframe
+
+client = Client()
+
+odds = client.get_odds(game_id="2026020080", snapshot_type="closing")
+df = to_dataframe(odds, key="odds")
+print(df[["bookmaker", "mlHome", "mlAway", "total"]])
+print("credits left:", client.last_credits_remaining)
+```
+
+### 2. Who played the most minutes (shift data)
+
+`get_shifts` returns every shift for every skater in a game, with start and end times.
+
+```python
+from puckapi import Client
+
+client = Client()
+
+shifts = client.get_shifts(game_id="2026020080", team="TOR")
+busiest = sorted(shifts["players"], key=lambda p: p["shift_seconds"], reverse=True)[:5]
+for p in busiest:
+    print(p["name"], p["shift_count"], "shifts,", p["shift_seconds"] // 60, "min")
+```
+
+### 3. A player's recent games
+
+Find a player id with `search_players`, then pull the game log.
+
+```python
+from puckapi import Client
+
+client = Client()
+
+match = client.search_players("Matthews", limit=1)["players"][0]
+log = client.get_player_game_log(match["id"], season="20252026", limit=5)
+print(match["name"], log)
+```
+
+## Credits
+
+Every method returns the `data` object from the response. After each call, `client.last_credits_used` and `client.last_credits_remaining` hold the counters from the `X-Credits-Used` and `X-Credits-Remaining` headers. Methods that take `estimate_only=True` return the price of a call without running or charging it.
+
+## Pandas
+
+```python
+from puckapi import to_dataframe
+
+df = to_dataframe(data)                # finds the main list in the response
+df = to_dataframe(data, key="rows")    # or name the list yourself
+```
+
+Nested fields become dotted columns. Install pandas separately or with `pip install "puckapi[pandas]"`.
+
+## Errors
+
+Every error is an `APIError` subclass, with the server's message and the HTTP status.
+
+| Exception | Status | Meaning |
+| --- | --- | --- |
+| `AuthError` | 401 | Missing, invalid or revoked key |
+| `InsufficientCreditsError` | 402 | Not enough credits for the call |
+| `NotFoundError` | 404 | The id or name does not exist |
+| `RateLimitError` | 429 | Too many requests; has `.retry_after` when the server sends it |
+| `APIError` | 400, 5xx | Bad arguments or a server problem |
+| `APIConnectionError` | none | No response (network or timeout) |
+
+```python
+from puckapi import Client, APIError, InsufficientCreditsError, RateLimitError
+
+client = Client()
+try:
+    data = client.list_teams()
+except InsufficientCreditsError:
+    print("Out of credits, top up at https://puckapi.com")
+except RateLimitError as exc:
+    print("Slow down, retry after", exc.retry_after)
+except APIError as exc:
+    print(exc.status_code, exc.message)
+```
+
+The client retries 429 and 5xx responses and connection failures up to 3 times with backoff, and honors `Retry-After`. Set `Client(max_retries=0)` to turn that off.
+
+If you see `CERTIFICATE_VERIFY_FAILED` on a python.org install for macOS, run the "Install Certificates.command" script that came with Python, or `pip install certifi` (the client uses it when present).
+
+## Options
+
+```python
+Client(
+    api_key=None,                          # defaults to $PUCKAPI_API_KEY
+    base_url="https://mcp.puckapi.com",           # point at another host
+    timeout=60.0,                          # seconds per request
+    max_retries=3,
+)
+```
+
+`client.call("tool_name", {"arg": "value"})` calls any tool by name, which helps when the API adds a tool before this package does.
+
+## Tools
+
+Method names match the API tool names. Arguments are keyword arguments; required ones can also be passed positionally. Each method's docstring lists its arguments (`help(client.list_teams)`).
+
+| Method | Credits | What it does |
+| --- | --- | --- |
+| `get_standings` | 2 | Standings |
+| `get_team_stats` | 5 | Team stats |
+| `list_teams` | 1 | List teams |
+| `get_games` | 5 | Games |
+| `get_schedule` | 2 | Schedule |
+| `get_game_detail` | 10 | Game detail |
+| `get_head_to_head` | 10 | Head to head |
+| `search_players` | 2 | Search players |
+| `get_player_stats` | 5 | Player stats |
+| `get_goalie_stats` | 5 | Goalie stats |
+| `get_skater_season_stats` | 5 | Skater season stats |
+| `get_player_game_log` | 5 | Player game log |
+| `get_odds` | 10 | Odds |
+| `get_line_movement` | 25 | Line movement |
+| `get_player_props` | 10 | Player props |
+| `get_prop_history` | 10 | Prop history |
+| `get_plays` | 10 | Plays |
+| `get_shot_map` | 10 | Shot map |
+| `get_shifts` | 10 | Shifts |
+| `get_situation_time` | 10 | Situation time |
+
+Full API reference: https://puckapi.com/docs
+
+## License
+
+MIT

puckapi-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "puckapi"
+dynamic = ["version"]
+description = "Python client for the PuckAPI NHL data API. No dependencies."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "PuckAPI", email = "support@puckapi.com" }]
+keywords = ["nhl", "sports-data", "api-client", "betting", "player-props", "odds", "puckapi"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+dependencies = []
+
+[project.optional-dependencies]
+pandas = ["pandas>=1.5"]
+test = ["pytest>=7"]
+
+[project.urls]
+Homepage = "https://puckapi.com"
+Documentation = "https://puckapi.com/docs"
+Repository = "https://github.com/noahowsh/puckapi"
+"Sign up" = "https://puckapi.com/signup"
+
+[tool.hatch.version]
+path = "src/puckapi/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/puckapi"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "tests", "README.md", "LICENSE", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

puckapi-0.1.0/src/puckapi/__init__.py

@@ -0,0 +1,25 @@
+"""PuckAPI: Python client for the PuckAPI NHL data API."""
+from ._core import (
+    APIConnectionError,
+    APIError,
+    AuthError,
+    InsufficientCreditsError,
+    NotFoundError,
+    RateLimitError,
+    to_dataframe,
+)
+from ._version import __version__
+from .client import TOOLS, Client
+
+__all__ = [
+    "APIConnectionError",
+    "APIError",
+    "AuthError",
+    "Client",
+    "InsufficientCreditsError",
+    "NotFoundError",
+    "RateLimitError",
+    "TOOLS",
+    "__version__",
+    "to_dataframe",
+]