How-To Guides
Problem-oriented guides for accomplishing specific tasks with NHL Scrabble.
These guides provide practical solutions to common problems. Each guide is independent and focuses on a specific goal.
Installation & Setup
Usage & Configuration
Troubleshooting
Quick Index
- Installation & Setup
- How to Install NHL Scrabble
Different ways to install NHL Scrabble (pip, UV, from source)
- How to Use UV Package Manager
Use UV package manager for 10-100x faster operations
- How to Setup Pre-commit Hooks
Configure pre-commit hooks for code quality automation
- Usage & Configuration
- How to Configure API Settings
Customize NHL API client behavior (timeouts, retries, rate limits)
- How to Customize Output Format
Control report formatting and display options
- How to Export to JSON
Export analysis results in JSON format for integration
- Development
- How to Run Tests
Execute test suite with different configurations
- How to Contribute Code
Submit code contributions via pull requests
- How to Add a New Report Type
Create custom report generators
- Troubleshooting
- How to Debug API Issues
Diagnose and fix NHL API connectivity problems
How These Guides Work
Each how-to guide:
Focuses on a specific goal (e.g., “export to JSON”)
Assumes you already know the basics (completed Tutorials)
Provides practical steps without extensive explanation
Includes working examples you can adapt
These guides follow the Diátaxis framework:
Goal-oriented - Help you accomplish something specific
Practical - Focus on steps, not concepts
Flexible - Can be followed in any order
Actionable - You can apply them immediately