Metadata-Version: 2.1
Name: ironbot
Version: 0.0.1
Summary: CLI to get information about Ironman professional races
License: GPL-3
Author: Eduardo Cuducos
Author-email: 4732915+cuducos@users.noreply.github.com
Requires-Python: >=3.9,<4.0
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
Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0)
Requires-Dist: httpx (>=0.24.1,<0.25.0)
Requires-Dist: pdftotext (>=2.2.2,<3.0.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# `ironbot`

## Requirements

 `ironbot` depends on Python 3.9 or newer, and on `pdftotext` which [requires `poppler`](https://github.com/jalan/pdftotext#os-dependencies).

## 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 URL to the PDF containing the start list for an...
  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 URL to the start list of an event

```console
$ ironbot start-list 4
https://files.constantcontact.com/a202847d001/81c60c53-85dd-45f9-b6aa-dd0fda086862.pdf
```

## Contributing

Make sure that both checks pass:

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

