.env.example

# sportsdataverse-py — environment template
# ----------------------------------------------------------------------------
# Copy to `.env` (gitignored), fill in your own values, and load into the shell:
#     bash/zsh:   cp .env.example .env  &&  set -a; source .env; set +a
#     or use direnv / python-dotenv / `uv run --env-file .env ...`
# This template is committed and MUST contain NO real secrets — placeholders only.
# ----------------------------------------------------------------------------

# ===== REQUIRED SECRETS (no bundled default) =====

# The Odds API key (sportsdataverse.odds, toa_*)
# Get your key from https://the-odds-api.com/#get-access
ODDS_API_KEY=your_odds_api_key_here

# CFBD API key — College Football Data API (used by the R package cfbfastR)
# Get your key from https://collegefootballdata.com/
CFBD_API_KEY=your_cfbd_key_here

# ===== OPTIONAL OVERRIDES (public defaults ship bundled) =====

# NFL.com auth (sportsdataverse.nfl.nfl_api / nfl_games). Defaults to the public
# WEB_DESKTOP web-app credentials; set these only to use your own. NFL_ACCESS_TOKEN
# injects a pre-minted bearer token verbatim (skips the device-grant mint).
# NFL_CLIENT_KEY=your_custom_client_key
# NFL_CLIENT_SECRET=your_custom_client_secret
# NFL_ACCESS_TOKEN=your_preminted_token

# Fox Sports (fox_* wrappers). Public data-tier key ships bundled; override on rotation.
# SDV_PY_FOX_DATA_KEY=your_custom_fox_key

# HockeyTech (ahl / ohl / whl / qmjhl / pwhl). Public per-league keys ship bundled;
# override a single league only if its key rotates.
# SDV_PWHL_API_KEY=your_pwhl_key
# SDV_AHL_API_KEY=your_ahl_key
# SDV_OHL_API_KEY=your_ohl_key
# SDV_WHL_API_KEY=your_whl_key
# SDV_QMJHL_API_KEY=your_qmjhl_key

# ===== CONFIGURATION FLAGS (not secrets) =====

# Enable live-API tests / notebook execution (default: unset -> live tests skip).
# SDV_PY_LIVE_TESTS=1

# NFL loader cache mode: off | memory | filesystem.
# SDV_PY_NFL_CACHE=memory