____ ____ ____ ______ ___ ____ _________ ______ ____ ____
|_ || _| .' `. .' ___ ||_ ||_ _| |_ ___ ||_ __ \ |_ _||_ _|
| |__| | / .--. \/ .' \_| | |_/ / | |_ \_| | |__) | \ \ / /
| __ | | | | || | | __'. | _| _ | ___/ \ \/ /
_| | | |_ \ `--' /\ `.___.'\ _| | \ \_ _| |___/ | _| |_ _| |_
|____||____| `.____.' `._____.'|____||____||_________||_____| |______|
_(pronounced like hockey-py so probably something like_ /ˈhɑː.kipaɪ/_)_
[](https://travis-ci.com/geckon/hockepy)
[](https://app.codacy.com/app/geckon/hockepy?utm_source=github.com&utm_medium=referral&utm_content=geckon/hockepy&utm_campaign=Badge_Grade_Dashboard)
[](https://lgtm.com/projects/g/geckon/hockepy/alerts/)
[](https://lgtm.com/projects/g/geckon/hockepy/context:python)
[](https://pyup.io/repos/github/geckon/hockepy/)
**Important:** Please keep in mind that `hockepy` is under active development
and any part can be changed anytime.
## 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 <https://statsapi.web.nhl.com/api/v1/>. 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/geckon/hockepy",
"name": "hockepy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Tom\u00e1\u0161 Heger",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/48/15/36e4e68833f4ae29aad972028dfec5c4be016b7c841f2622ef4252e02c45/hockepy-0.2.tar.gz",
"platform": null,
"description": " ____ ____ ____ ______ ___ ____ _________ ______ ____ ____\n |_ || _| .' `. .' ___ ||_ ||_ _| |_ ___ ||_ __ \\ |_ _||_ _|\n | |__| | / .--. \\/ .' \\_| | |_/ / | |_ \\_| | |__) | \\ \\ / /\n | __ | | | | || | | __'. | _| _ | ___/ \\ \\/ /\n _| | | |_ \\ `--' /\\ `.___.'\\ _| | \\ \\_ _| |___/ | _| |_ _| |_\n |____||____| `.____.' `._____.'|____||____||_________||_____| |______|\n\n_(pronounced like hockey-py so probably something like_ /\u02c8h\u0251\u02d0.kipa\u026a/_)_\n\n[](https://travis-ci.com/geckon/hockepy)\n[](https://app.codacy.com/app/geckon/hockepy?utm_source=github.com&utm_medium=referral&utm_content=geckon/hockepy&utm_campaign=Badge_Grade_Dashboard)\n[](https://lgtm.com/projects/g/geckon/hockepy/alerts/)\n[](https://lgtm.com/projects/g/geckon/hockepy/context:python)\n[](https://pyup.io/repos/github/geckon/hockepy/)\n\n**Important:** Please keep in mind that `hockepy` is under active development\nand any part can be changed anytime.\n\n## Installation\n\n```\npip install hockepy\n```\n\n## CLI utility\n\nThe main purpose of `hockepy` is to provide a command line utility for geeky\nhockey fans. The easiest way to discover the features currently implemented is\nto display help:\n\n $ hockepy -h\n usage: hocke.py [-h] [-D] [-v] {today,schedule} ...\n\n positional arguments:\n {today,schedule}\n\n optional arguments:\n -h, --help show this help message and exit\n -D, --debug turn debug output on\n -v, --verbose turn verbose output on\n\nSubcommands also support `-h` option:\n\n $ hockepy schedule -h\n usage: hocke.py schedule [-h] [--home-first] [--utc]\n [first_date] [last_date]\n\n positional arguments:\n first_date first date to get schedule for\n last_date last date to get schedule for\n\n optional arguments:\n -h, --help show this help message and exit\n --home-first print the home team first\n --utc print times in UTC instead of local time\n\nBear in mind that the actual help may differ as this listing won't necessarily\nbe updated with any feature addition/change.\n\n### Configuration\n\nYou can highlight your favorite team using a configuration file called\n`.hockepy.conf` (an example is included in the repository):\n\n```\nhighlight_teams = [\n \"Boston Bruins\",\n \"Pittsburgh Penguins\",\n]\n```\n\nThe file can be placed in the current working directory, your home directory or\nin a directory specified by HOCKEPY_CONF_DIR (hockepy checks in that order).\n\n## NHL API\n\nAnother goal is to offer a Python interface to a subset of NHL API. Other\nleagues may or may not be added as well but the main plan is to support NHL for\nnow.\n\nNHL API is available at <https://statsapi.web.nhl.com/api/v1/>. I am not aware\nof any available documentation so it's been discovering and trial-and-error for\nme so far. If you know about any documentation, let me know.\n\nPlease note that any usage of the API (and therefore usage of `hockepy` as\nwell) is likely subject to\n[NHL Terms of Service](https://www.nhl.com/info/terms-of-service).\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "CLI utility and (a subset of) NHL API for hockey nerds",
"version": "0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cd9229a02e01e7af689fb756347fc77124b4d23b1f61d41fb185fffcb69894e",
"md5": "6e742f0587cd70d4a9c1dbe121caf804",
"sha256": "28b14c3dfe57c30f6f7516406a869a1d03246828c8899bc6a0b0742b9cea41fc"
},
"downloads": -1,
"filename": "hockepy-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e742f0587cd70d4a9c1dbe121caf804",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 16749,
"upload_time": "2023-03-12T18:42:59",
"upload_time_iso_8601": "2023-03-12T18:42:59.402949Z",
"url": "https://files.pythonhosted.org/packages/0c/d9/229a02e01e7af689fb756347fc77124b4d23b1f61d41fb185fffcb69894e/hockepy-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "481536e4e68833f4ae29aad972028dfec5c4be016b7c841f2622ef4252e02c45",
"md5": "a49a8fdea7bc8ca8bb24463c59ba4274",
"sha256": "f700b4104fbd0036957c8c7151256cab5245ccf0e9a54d2b5634caf8c9843000"
},
"downloads": -1,
"filename": "hockepy-0.2.tar.gz",
"has_sig": false,
"md5_digest": "a49a8fdea7bc8ca8bb24463c59ba4274",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 12362,
"upload_time": "2023-03-12T18:43:00",
"upload_time_iso_8601": "2023-03-12T18:43:00.615141Z",
"url": "https://files.pythonhosted.org/packages/48/15/36e4e68833f4ae29aad972028dfec5c4be016b7c841f2622ef4252e02c45/hockepy-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-12 18:43:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "geckon",
"github_project": "hockepy",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "hockepy"
}
JSON
