https://github.com/geckon/hockepy
CLI utility and (a subset of) NHL API for hockey nerds
https://github.com/geckon/hockepy
api cli cli-utility hockey ice-hockey nhl nhl-api
Last synced: about 1 month ago
JSON representation
CLI utility and (a subset of) NHL API for hockey nerds
- Host: GitHub
- URL: https://github.com/geckon/hockepy
- Owner: geckon
- License: gpl-3.0
- Created: 2017-01-31T21:31:48.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2026-01-10T09:57:41.000Z (about 2 months ago)
- Last Synced: 2026-01-11T03:12:15.343Z (about 2 months ago)
- Topics: api, cli, cli-utility, hockey, ice-hockey, nhl, nhl-api
- Language: Python
- Homepage:
- Size: 428 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
____ ____ ____ ______ ___ ____ _________ ______ ____ ____
|_ || _| .' `. .' ___ ||_ ||_ _| |_ ___ ||_ __ \ |_ _||_ _|
| |__| | / .--. \/ .' \_| | |_/ / | |_ \_| | |__) | \ \ / /
| __ | | | | || | | __'. | _| _ | ___/ \ \/ /
_| | | |_ \ `--' /\ `.___.'\ _| | \ \_ _| |___/ | _| |_ _| |_
|____||____| `.____.' `._____.'|____||____||_________||_____| |______|
_(pronounced like hockey-py so probably something like_ /ˈhɑː.kipaɪ/_)_
[](https://travis-ci.com/geckon/hockepy)
[](https://app.codacy.com/gh/geckon/hockepy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://lgtm.com/projects/g/geckon/hockepy/alerts/)
[](https://lgtm.com/projects/g/geckon/hockepy/context:python)
[](https://pyup.io/repos/github/geckon/hockepy/)
## Installation
```
pip install hockepy
```
## CLI utility
The main purpose of `hockepy` is to provide a command line utility for geeky
hockey fans. The easiest way to discover the features currently implemented is
to display help:
$ hockepy -h
usage: hocke.py [-h] [-D] [-v] {today,schedule} ...
positional arguments:
{today,schedule}
optional arguments:
-h, --help show this help message and exit
-D, --debug turn debug output on
-v, --verbose turn verbose output on
Subcommands also support `-h` option:
$ hockepy schedule -h
usage: hocke.py schedule [-h] [--home-first] [--utc]
[first_date] [last_date]
positional arguments:
first_date first date to get schedule for
last_date last date to get schedule for
optional arguments:
-h, --help show this help message and exit
--home-first print the home team first
--utc print times in UTC instead of local time
Bear in mind that the actual help may differ as this listing won't necessarily
be updated with any feature addition/change.
### Configuration
You can highlight your favorite team using a configuration file called
`.hockepy.conf` (an example is included in the repository):
```
highlight_teams = [
"Boston Bruins",
"Pittsburgh Penguins",
]
```
The file can be placed in the current working directory, your home directory or
in a directory specified by HOCKEPY_CONF_DIR (hockepy checks in that order).
## NHL API
Another goal is to offer a Python interface to a subset of NHL API. Other
leagues may or may not be added as well but the main plan is to support NHL for
now.
NHL API is available at . I am not aware
of any available documentation so it's been discovering and trial-and-error for
me so far. If you know about any documentation, let me know.
Please note that any usage of the API (and therefore usage of `hockepy` as
well) is likely subject to
[NHL Terms of Service](https://www.nhl.com/info/terms-of-service).