Metadata-Version: 2.1
Name: ironbot
Version: 0.0.3
Summary: CLI to get information about Ironman professional races
Home-page: https://github.com/cuducos/ironbot/
License: GPLv3
Keywords: triathlon,Ironamn,Professional triathletes,Professional triathlon races
Author: Eduardo Cuducos
Author-email: 4732915+cuducos@users.noreply.github.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0)
Requires-Dist: camelot-py (>=0.11.0,<0.12.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Project-URL: Repository, https://github.com/cuducos/ironbot/
Description-Content-Type: text/markdown

# `ironbot`

## 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 both checks pass:

```console
$ poetry run mypy **/*.py
$ poetry black --check .
```

