# `ironbot` [](https://github.com/cuducos/ironbot/actions/workflows/tests.yml)
## Requirements
`ironbot` depends on Python 3.9 or newer, and on [Camelot, which requires `ghostscript`](https://camelot-py.readthedocs.io/en/master/user/install-deps.html).
## Install
```console
$ pip install ironbot
```
## Usage
```console
$ ironbot --help
Usage: ironbot [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
--help Show this message and exit.
Commands:
calendar List the details of the upcoming Ironman professional races.
start-list Gets the start list for an Ironman professional race (use...
start-lists List upcoming Ironman professional races with start list...
```
### Exemples
#### Details of upcoming Ironman professional races
```console
$ ironbot calendar
2023-06-04 IRONMAN Hamburg - MPRO European Championship $75,000 5MPRO CLOSED CLOSED
2023-06-10 IRONMAN 70.3 Boulder $50,000 2MPRO/2WPRO CLOSED CLOSED
2023-06-11 IRONMAN 70.3 Warsaw $15,000 2MPRO/2WPRO CLOSED CLOSED
…
```
#### List events with start list available
```console
$ ironbot start-lists
Choose one of the followign events to use with `start-list` command:
[1] 2023 IRONMAN European Championship Hamburg
[2] 2023 IRONMAN 70.3 Boulder
…
```
#### Get the start list of an event
```console
$ ironbot start-list 4
1 Daniela Ryf CHE (Switzerland)
3 Ashleigh Gentle AUS (Australia)
4 Anne Reischmann DEU (Germany)
…
```
## Contributing
Make sure that all tests pass:
```console
$ poetry run pytest
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cuducos/ironbot/",
"name": "ironbot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "triathlon,Ironamn,Professional triathletes,Professional triathlon races",
"author": "Eduardo Cuducos",
"author_email": "4732915+cuducos@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/c0/0b/2a7a941e60e7acec474c5747c0eda5ec1aafda572ebed9d1471448f57794/ironbot-0.0.6.tar.gz",
"platform": null,
"description": "# `ironbot` [](https://github.com/cuducos/ironbot/actions/workflows/tests.yml)\n\n## Requirements\n\n `ironbot` depends on Python 3.9 or newer, and on [Camelot, which requires `ghostscript`](https://camelot-py.readthedocs.io/en/master/user/install-deps.html).\n\n## Install\n\n```console\n$ pip install ironbot\n```\n\n## Usage\n\n```console\n$ ironbot --help\nUsage: ironbot [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --install-completion [bash|zsh|fish|powershell|pwsh]\n Install completion for the specified shell.\n --show-completion [bash|zsh|fish|powershell|pwsh]\n Show completion for the specified shell, to\n copy it or customize the installation.\n --help Show this message and exit.\n\nCommands:\n calendar List the details of the upcoming Ironman professional races.\n start-list Gets the start list for an Ironman professional race (use...\n start-lists List upcoming Ironman professional races with start list...\n```\n\n### Exemples\n\n#### Details of upcoming Ironman professional races\n\n```console\n$ ironbot calendar\n2023-06-04\tIRONMAN Hamburg - MPRO European Championship\t$75,000\t5MPRO\tCLOSED\tCLOSED\n2023-06-10\tIRONMAN 70.3 Boulder\t$50,000\t2MPRO/2WPRO\tCLOSED\tCLOSED\n2023-06-11\tIRONMAN 70.3 Warsaw\t$15,000\t2MPRO/2WPRO\tCLOSED\tCLOSED\n\u2026\n```\n\n#### List events with start list available\n\n```console\n$ ironbot start-lists\nChoose one of the followign events to use with `start-list` command:\n [1] 2023 IRONMAN European Championship Hamburg\n [2] 2023 IRONMAN 70.3 Boulder\n \u2026\n```\n\n#### Get the start list of an event\n\n```console\n$ ironbot start-list 4\n1\tDaniela Ryf\tCHE (Switzerland)\n3\tAshleigh Gentle\tAUS (Australia)\n4\tAnne Reischmann\tDEU (Germany)\n\u2026\n```\n\n## Contributing\n\nMake sure that all tests pass:\n\n```console\n$ poetry run pytest\n```\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "CLI to get information about Ironman professional races",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/cuducos/ironbot/",
"Repository": "https://github.com/cuducos/ironbot/"
},
"split_keywords": [
"triathlon",
"ironamn",
"professional triathletes",
"professional triathlon races"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23405070de49b12bdf13ec246d4ef58fb26fc69dda969de081451e659b661af7",
"md5": "224b0267650aee0d63632bcd3e81a254",
"sha256": "5a6b2519d742f202079622e22b52bb63d991d70082aebd66d3ddcacbb5d8cdb8"
},
"downloads": -1,
"filename": "ironbot-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "224b0267650aee0d63632bcd3e81a254",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 18005,
"upload_time": "2023-06-09T05:52:23",
"upload_time_iso_8601": "2023-06-09T05:52:23.572460Z",
"url": "https://files.pythonhosted.org/packages/23/40/5070de49b12bdf13ec246d4ef58fb26fc69dda969de081451e659b661af7/ironbot-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c00b2a7a941e60e7acec474c5747c0eda5ec1aafda572ebed9d1471448f57794",
"md5": "f3dc35102db4a3a1ebfd94d72066349f",
"sha256": "d612d04cd34c046d91fc49203de5020c53d169438e65e985abc3260b8f410c37"
},
"downloads": -1,
"filename": "ironbot-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "f3dc35102db4a3a1ebfd94d72066349f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 16910,
"upload_time": "2023-06-09T05:52:26",
"upload_time_iso_8601": "2023-06-09T05:52:26.173558Z",
"url": "https://files.pythonhosted.org/packages/c0/0b/2a7a941e60e7acec474c5747c0eda5ec1aafda572ebed9d1471448f57794/ironbot-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-09 05:52:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cuducos",
"github_project": "ironbot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ironbot"
}
JSON
