Skip to main content

Terminal tool for watching hockey games

Project description

Faceoff

Faceoff Logo

A terminal user interface (TUI) application for following NHL hockey games in real-time.

Python License

Features

  • Live Game Schedule: Browse NHL games by date with easy navigation (previous/next day)
  • Real-time Updates: Auto-refreshing scores for live games
  • Game Details: View play-by-play, box scores, and scoring summaries for in-progress and completed games
  • Pre-Game Preview: View matchup data including goalie comparison and skater leaders for upcoming games
  • League Standings: View current NHL standings with multiple views (Wild Card, Division, Conference, League)
  • Player Stats Leaders: View top players in various statistical categories for skaters and goalies
  • Team Browser: Browse all NHL teams, view rosters, and team schedules
  • Player Profiles: View detailed player information, career stats, and game logs
  • Responsive Layout: Game cards automatically arrange based on terminal width
  • Local Time Display: Game times shown in your local timezone with timezone abbreviation

Installation

Using uvx (recommended)

uvx faceoff

Using pip

pip install faceoff

Then run:

faceoff

From source

git clone https://github.com/vgreg/faceoff.git
cd faceoff
uv run faceoff

Screenshots

Game detail view (shown with different terminal color schemes):

Game detail view

Game detail view, dark theme

Game detail view, warm theme

League standings:

League standings

Acknowledgments

This project was inspired by Playball, a similar terminal application for following MLB baseball games.

Built With

  • Textual - The modern TUI framework for Python that powers the user interface
  • nhl-stats-api-client - Python client for accessing NHL API data

Disclaimer

This project is not affiliated with, endorsed by, or in any way officially connected with the National Hockey League (NHL), any of its teams, or any of its affiliates. All NHL logos, trademarks, and data are the property of the NHL and its teams.

This application uses publicly available NHL API data for informational and educational purposes only.

Development

Setup

git clone https://github.com/vgreg/faceoff.git
cd faceoff
make install

Running Tests

uv run pytest

Linting

uv run ruff check src/

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

faceoff-0.3.0.tar.gz (393.2 kB view details)

Uploaded Source

Built Distribution

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

faceoff-0.3.0-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file faceoff-0.3.0.tar.gz.

File metadata

  • Download URL: faceoff-0.3.0.tar.gz
  • Upload date:
  • Size: 393.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for faceoff-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6299f41a885638b1e24a3f27f8392ea101af4926b021181e2cb3f601caf78c9e
MD5 69bc7afbf0b6fe0da1c9594ac29f920d
BLAKE2b-256 73c41fd0c25a934b5331077948e9e8900c56881b604b6cf56aad8b26cc7eeaf9

See more details on using hashes here.

Provenance

The following attestation bundles were made for faceoff-0.3.0.tar.gz:

Publisher: publish.yml on vgreg/faceoff

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file faceoff-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: faceoff-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 38.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for faceoff-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a998cbb1623c6f21702a2cf70b8581dfd742459de5621ddbc9f371c6a4e47ed
MD5 d9edf3e1d75311e6ce3742318ab9c90b
BLAKE2b-256 d134d9e30ee1fe83205d60c894ca718aca923260e91b637e072dd8eba27e6b37

See more details on using hashes here.

Provenance

The following attestation bundles were made for faceoff-0.3.0-py3-none-any.whl:

Publisher: publish.yml on vgreg/faceoff

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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