Metadata-Version: 2.1
Name: fetchrunner
Version: 0.1.0
Summary: A CLI tool to fetch running race information from Kikourou website.
Author: Arnaud Trog
Project-URL: Homepage, https://github.com/Arnautt/fetchrunner
Project-URL: Repository, https://github.com/Arnautt/fetchrunner.git
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: pandas==2.2.2
Requires-Dist: beautifulsoup4==4.12.3
Requires-Dist: requests==2.32.3
Requires-Dist: loguru==0.7.2
Requires-Dist: colorama==0.4.6
Requires-Dist: pyfiglet==1.0.2

# Fetchrunner - Retrieve runner race results

This tool fetches running race results for a runner by retrieving informations from Kikourou website.

## 🛠️ Installation


### With PyPI


```bash
pip install fetchrunner
```


### With Github


```bash
git clone https://github.com/arnautt/fetchrunner.git
cd fetchrunner/
pip install -e .
```


### With Docker


```bash
docker build . -t fetchrunner-image
docker run fetchrunner-image fetchrunner --name "Arnaud, Trog"
```


## ⚡ Usage

To fetch race results for a runner, simply use:

```
fetchrunner --name "FirstName, Surname" --save path/to/save/folder
```

Remark: Name format is important, don't forget the comma and start with the first name

## 📄 Output


![CLI output](assets/output.png)



## 📋 TODO

- [] Integrate unit testing in CI/CD
- [] Add automatic deploy to Pypi with Github actions
- [] Handle names with special characters
