Skip to main content

Follow any MLB game in your shell - the utility player for baseball fans

Project description

Utilityman

Follow your favorite MLB teams with live play-by-play in the terminal.

Scorebug example

Example output

⚾ Game On! ⚾
Teams: Los Angeles Dodgers at Baltimore Orioles  
Pitchers: Clayton Kershaw vs. Tomoyuki Sugano
📍 Oriole Park at Camden Yards
🕐 Sun 10:35 AM PDT

▲1  Shohei Ohtani homers (47) on a fly ball to center field. (1 RBI) (1-0) ○○○
▲1  Mookie Betts strikes out swinging. (3-3) ○○○
────────────────────────────────────────────────
🏟️  ▲ Top 1
     ⚾ LAD  1  (H: 1 E:0)
     ⚾ BAL  0  (H: 0 E:0)

Install

  • From PyPI

    pip install utilityman
    
  • Local checkout (editable)

    • Clone this repo
    • pip install -e .

Requires Python 3.9+.

Usage

  • Positional team or prompt
utilityman dodgers
# or just run `utilityman` and enter a team when prompted
utilityman --gamepk 776443
  • Show every pitch and start from the first at-bat
utilityman yankees --pitches --from-start

What it does

  • Finds today's game for a team (or uses --gamepk)
  • Streams new at-bats and optionally every pitch as the game unfolds
  • Prints a compact scoreboard on change or inning transitions
  • Highlights scoring plays in real time
  • If no game is live, prints the last final and the next scheduled game

Outputs

  • Uses team abbreviations in the scoreboard
  • Shows ▲ for top and ▼ for bottom of the inning
  • Reprints a play if its description updates
  • Prints the scoreboard at start of halves and on End/Middle of innings
  • Prints an inning banner on half-inning transitions for readability
  • Colors: cyan for away, magenta for home, green for scoring plays
  • Disable color with --no-color
  • Includes ball-strike count and approximate pitch count per at-bat
  • Shows base runners when available (◉ occupied, ○ empty)
  • Pre-game shows probable pitchers and local start time
  • If a team has multiple games today, you can select which one to follow

CLI reference

  • team: team id, abbr, or name (e.g., 119, LAD, Dodgers)
  • --team: same as positional team
  • --date YYYY-MM-DD: date to search (default: today in Los Angeles)
  • --gamepk: MLB gamePk to stream directly
  • --interval: poll seconds (default 2.5)
  • --pitches: print each pitch
  • --from-start: print all prior at-bats on first fetch
  • --no-color: disable ANSI color
  • --scoring-only: only print scoring plays and inning transitions
  • --opponent TEAM: disambiguate doubleheaders by opponent (id, abbr, or name)
  • --log FILE: append the live stream to a file
  • --dump FILE: write full game log for the selected game and exit
  • --tz ZONE: override local timezone (e.g., America/New_York)
  • --line-score: print inning-by-inning linescore under the scoreboard
  • --box-interval N: every N minutes, reprint the scoreboard even if unchanged
  • --quiet: only scoreboard and inning banners
  • --verbose: extra details (pitches and runners)

Notes

  • Data comes from MLB StatsAPI schedule and the v1.1 live feed
  • Uses If-None-Match to avoid reprinting unchanged states
  • Team IDs are cached in ~/.utilityman/teams-<season>.json to reduce API calls

Config (optional)

Create ~/.utilityman/config.toml to set defaults:

team = "Dodgers"          # default team
tz = "America/Los_Angeles" # IANA timezone
interval = 2.5             # poll seconds
no_color = false           # disable ANSI color
line_score = true          # show inning-by-inning line score
box_interval = 5           # minutes between forced scoreboard prints

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

utilityman-0.4.0.tar.gz (949.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

utilityman-0.4.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file utilityman-0.4.0.tar.gz.

File metadata

  • Download URL: utilityman-0.4.0.tar.gz
  • Upload date:
  • Size: 949.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for utilityman-0.4.0.tar.gz
Algorithm Hash digest
SHA256 2611bba06ac73d1b8a585a82bdaa04a1d2a4d1b1383348560a111d0a20c779a2
MD5 c28a585e042409740116e8b0fedab200
BLAKE2b-256 b7a275b398b3a00629a6aa58311bdc11c2faa91d78a2f8dc8ce62895009ed3c5

See more details on using hashes here.

File details

Details for the file utilityman-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: utilityman-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for utilityman-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0cff08424b14c9603e07f21fe6cf0c409e20bc204b12082625100c014735e10a
MD5 0eb7bdd0c3764fe0cfc5c26edc9fdd8a
BLAKE2b-256 e2ec833ae994bc6cf444d12c89530ba53b36793c23eb3bf0f243f1aaaa2c9320

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page