From 4d40494f3e9aade0f5302678e4df67a7613c157b Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Wed, 15 Apr 2026 22:37:06 -0500 Subject: update README --- nba_scores.egg-info/PKG-INFO | 76 +++++++++++++++++++++++++++++++---------- nba_scores.egg-info/SOURCES.txt | 3 ++ 2 files changed, 61 insertions(+), 18 deletions(-) (limited to 'nba_scores.egg-info') diff --git a/nba_scores.egg-info/PKG-INFO b/nba_scores.egg-info/PKG-INFO index b0263b8..a440054 100644 --- a/nba_scores.egg-info/PKG-INFO +++ b/nba_scores.egg-info/PKG-INFO @@ -19,16 +19,19 @@ Dynamic: license-file # NBA -NBA is a simple Python package that provides you with a quick and easy -command-line interface to current NBA scores and standings. +![](./screenshots/preview.png) -See the [Installation](#installation) & [Usage](#usage) sections below -for more information. +NBA is a Python package that provides a command-line interface to current NBA +scores, standings, statistical leaders, playoff picture, and live box scores. +It supports both a static one-shot mode and an interactive TUI with +auto-refresh. # Table of Contents - [Installation](#installation) - [Usage](#usage) + - [Interactive TUI](#interactive-tui) + - [Static output](#static-output) - [Contributing](#contributing) # Installation @@ -43,33 +46,70 @@ pipx install nba-scores ## Manual -To run the script locally, run the following commands: - ```shell git clone https://git.cleberg.net/nba-scores.git cd nba-scores -pipx install . +uv sync ``` -![Installation](./screenshots/installation.png) - # Usage [Back to top](#table-of-contents) -All commands can be passed to the program with the following template: -`nba ` +## Interactive TUI + +Launch the full interactive terminal UI: + +```shell +nba --tui +``` + +Optional flags: + +| Flag | Description | +|--------------------|--------------------------------------------------------| +| `--tui` | Launch the interactive TUI | +| `--scores` | Open TUI on the Scores tab (default) | +| `--standings` | Open TUI on the Standings tab | +| `--refresh N` | Auto-refresh interval in seconds (default: 60, min: 10)| + +### TUI tabs + +| Tab | Key | Description | +|-----------------|-----|----------------------------------------------------------| +| Scores | `s` | Today's games with live scores and status | +| Standings | `t` | East / West conference standings, side by side | +| Leaders | `l` | Top 25 players by stat category | +| Playoff Picture | `p` | Conference seeding with clinch and elimination status | +| Box Score | `b` | Per-player live stats for a selected game | + +### TUI key bindings + +| Key | Action | +|---------|------------------------------------------------| +| `1`–`9` | Load box score for game N from the Scores tab | +| `,` | Cycle to the previous leaders stat category | +| `.` | Cycle to the next leaders stat category | +| `r` | Refresh all data immediately | +| `q` | Quit | + +### Leaders stat categories + +Cycles through: Points, Rebounds, Assists, Steals, Blocks, Efficiency, FG%, FT%, 3P% + +## Static output + +Print scores or standings directly to the terminal without launching the TUI: | Argument | Shortcut | Description | |---------------|----------|-----------------------------------| -| `--scores` | `-sc` | Show today's scoreboard | -| `--standings` | `-st` | Show current conference standings | - -Scores: -![Scores](./screenshots/scores.png) +| `--scores` | `-sc` | Print today's scoreboard | +| `--standings` | `-st` | Print current conference standings| -Standings: -![Standings](./screenshots/standings.png) +```shell +nba --scores +nba --standings +``` # Contributing diff --git a/nba_scores.egg-info/SOURCES.txt b/nba_scores.egg-info/SOURCES.txt index b5c9c92..c424bb6 100644 --- a/nba_scores.egg-info/SOURCES.txt +++ b/nba_scores.egg-info/SOURCES.txt @@ -3,8 +3,11 @@ README.md pyproject.toml nba/__init__.py nba/__main__.py +nba/box_score.py nba/cli.py nba/fetch_data.py +nba/leaders.py +nba/playoff.py nba/scores.py nba/standings.py nba/tui/__init__.py -- cgit v1.2.3