ScraperNHL Documentation

NHL data scraping package with Expected Goals (xG) model.

Overview

ScraperNHL is a Python package designed for scraping and analyzing NHL data. This documentation will guide you through the installation, usage, and features of the package.

Python Version: 3.9+ (tested on 3.9-3.13)

Installation

Stable (PyPI):

pip install scrapernhl

Latest (GitHub):

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

See Getting Started for more installation options.

Features

• Fast NHL data scraping using selectolax
• Pre-trained XGBoost Expected Goals model
• Command-line interface (CLI) for quick data exports
• Support for play-by-play data with xG calculations
• Efficient data processing with polars

Quick Links

• Getting Started
• API Reference
• CLI Examples - Command-line usage
• Python Examples - Python API usage
• About the Project
• GitHub Repository
• PyPI Package
• Announcements - Latest news and updates