Skip to main content

Follow any MLB game in your shell

Project description

scorebug: live MLB play-by-play for your shell

Follow MLB games in your terminal. Fast to start, easy to read, scriptable.

Install

  • From PyPI

    pip install scorebug
    
  • Local checkout (editable)

    • Clone this repo
    • pip install -e .

Requires Python 3.9+.

Usage

  • Positional team or prompt
scorebug dodgers
# or just run `scorebug` and enter a team when prompted
  • Specific game by gamePk
scorebug --gamepk 716910
  • Show every pitch and start from the first at-bat
scorebug 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
  • Prints a compact scoreboard on change or inning transitions
  • Highlights scoring plays
  • If no game is live, prints the last final and the next scheduled game

Output behavior

  • 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)

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

Notes

  • Data comes from MLB StatsAPI schedule and the v1.1 live feed
  • Uses If-None-Match to avoid reprinting unchanged states

Roadmap

  • ASCII line score per inning (lightweight)
  • RISP highlighting and men-on-base summary lines
  • Opponent filter improvements when multiple games in a day
  • Config file for defaults and cached team map
  • Better historical dump by team/date range

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

scorebug-0.1.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

scorebug-0.1.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file scorebug-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for scorebug-0.1.0.tar.gz
Algorithm Hash digest
SHA256 46d8d81e8869f000bc238eeb5323da649485fd961adb733db12291d93d33aa0d
MD5 e5556f15a3a98a5ed0fe53050b755e7a
BLAKE2b-256 2baa26d3b8c167ffa2686aa76f89e0f857ca779aae0b837de447cb47097824a6

See more details on using hashes here.

File details

Details for the file scorebug-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for scorebug-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3b9fdb227362cbff903d4395bb495632e16394dab158095dde8c4d035ef8452
MD5 52a268f222bc72382759db46ee8ee1fa
BLAKE2b-256 48f9fa0bd887da7a14cac3f57937c92da3d8cb72a100b70cb389b03f0fc02415

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