Getting Started¶

Install the package and start scraping NHL data in minutes.

Installation¶

From PyPI (Stable)¶

Install the latest stable version:

pip install scrapernhl

Or with uv:

uv add scrapernhl

From GitHub (Latest)¶

Install the development version with the latest features and fixes:

pip install git+https://github.com/maxtixador/scrapernhl.git

Or with uv:

uv pip install git+https://github.com/maxtixador/scrapernhl.git

From Source¶

For development or local modifications:

git clone https://github.com/maxtixador/scrapernhl.git
cd scrapernhl
pip install -e .

Quick Start¶

Command-Line Interface¶

The fastest way to get started is using the CLI:

# Get help
python scrapernhl/cli.py --help

# Scrape all NHL teams
python scrapernhl/cli.py teams

# Get a team's schedule
python scrapernhl/cli.py schedule MTL 20252026

# Get current standings
python scrapernhl/cli.py standings

See CLI Examples for more examples.

Python API¶

from scrapernhl import *

# Scrape teams
teams = scrape_teams()

# Scrape schedule
schedule = scrape_schedule('MTL', '20252026')

# Scrape standings
standings = scrape_standings('2026-01-01')

See API Reference for all available functions.

Requirements¶

Python >= 3.12
See full dependencies in pyproject.toml