Getting Started

New to NHL Scrabble? Start here for installation and first steps.

Quick Start Guides

• How to Install NHL Scrabble
  • Problem
  • Solutions
  • Verification
  • Troubleshooting
  • Platform-specific notes
  • Uninstallation
  • Related
• Getting Started with NHL Scrabble
  • What you’ll learn
  • Prerequisites
  • Installation Options
  • Step 1: Clone the repository
  • Step 2: Set up the development environment
  • Step 3: Run your first analysis
  • Step 4: Understanding the output
  • Step 5: Save output to a file
  • Step 6: Try JSON output
  • Step 7: Customize the output
  • What you’ve learned
  • Next steps
  • Troubleshooting
  • Getting help

Installation

The easiest way to install NHL Scrabble is via pip:

pip install nhl-scrabble

For faster installation using UV:

uv pip install nhl-scrabble

From Source

To install from source:

git clone https://github.com/bdperkin/nhl-scrabble.git
cd nhl-scrabble
pip install -e .

Quick Start

Run your first analysis:

nhl-scrabble analyze

This will:

1. Fetch current NHL roster data from the official API

2. Calculate Scrabble scores for all players

3. Generate comprehensive team standings

4. Display playoff bracket based on scores

Example Output

NHL Scrabble Score Analyzer
============================

Top 20 Individual Player Scores
--------------------------------
1. Alexander Ovechkin (WSH): 45 points
2. Sidney Crosby (PIT): 42 points
...

Conference Standings
--------------------
Eastern Conference:
1. Boston Bruins: 1,234 total points
...

See first-analysis for detailed explanation of the output.

Next Steps

• first-analysis - Understand the analysis output

• User Guide - Learn advanced usage

• Reference - Explore all CLI options