NHL Scrabble Score Analyzer Documentation
A Python application that fetches current NHL roster data and calculates “Scrabble scores” for player names based on standard Scrabble letter values.
Learning-oriented lessons that take you from zero to productive. Start here if you’re new to NHL Scrabble.
Problem-oriented guides for accomplishing specific tasks. Practical solutions to common problems.
Understanding-oriented background and design rationale. Learn why things work the way they do.
Information-oriented technical specifications. Complete CLI, configuration, and API reference.
Auto-generated Python API reference from docstrings. For developers extending the package.
Contributing guidelines, testing, and development setup. For project contributors.
Features
- 🏒 Live NHL Data
Fetches current roster data from the official NHL API
- 📊 Comprehensive Reports
Multiple report types including conference, division, playoff brackets, and statistics
- 🎯 Flexible Output
Text or JSON format output
- ⚙️ Configurable
Customize via environment variables or command-line options
- 🧪 Well-Tested
Comprehensive test suite with >90% coverage on core modules
- 📦 Modern Python
Type hints, Pydantic models, and best practices
Requirements
Python Version:
Python 3.12 or higher (3.12, 3.13, 3.14, 3.15)
Python 3.15-dev is tested but experimental
Dependencies:
requests, click, pydantic, python-dotenv, rich, fastapi, uvicorn, jinja2
Compatibility
The project is tested on Python 3.12 through 3.15 in CI. Python 3.15 is in development and while we test against it, compatibility is not guaranteed until Python 3.15 is officially released.
See .github/workflows/ci.yml for the full test matrix.
Quick Example
# Install
pip install nhl-scrabble
# Run analysis
nhl-scrabble analyze
# JSON output
nhl-scrabble analyze --format json --output report.json
# Run nhl-scrabble --help to see all options
$ nhl-scrabble --help
Table of Contents
Getting Started
User Documentation
- How-To Guides
- How to Install NHL Scrabble
- How to Use UV Package Manager
- How to Setup Pre-commit Hooks
- How to Configure API Settings
- How to Customize Output Format
- How to Export to JSON
- How to Run Tests
- How to Contribute Code
- How to Add a New Report Type
- How to Debug API Issues
- Quick Index
- How These Guides Work
- Related Documentation
- Reference
Understanding
API Documentation
Development
- Development Guide
- How to Contribute Code
- How to Run Tests
- How to Setup Pre-commit Hooks
- Architecture Overview
- Testing Philosophy
- Quick Links for Contributors
- Development Setup
- Testing
- Code Quality
- Code Style Standards
- Contributing Workflow
- Building Documentation
- Release Process
- Project Resources
- Development Tools
- Community
Project Links