Metadata-Version: 2.4
Name: monaco-qualifying
Version: 0.1.10
Summary: Analysis of Formula 1 qualification results.
Project-URL: Homepage, https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing
Project-URL: Issues, https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing/-/issues
Author-email: Liliia Shpytsia <fioletowujsemizwetik@gmail.com>
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# monaco-qualifying

[License: MIT](https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing/-/blob/dev/LICENSE)  
[GitLab Repo](https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing)

Python-пакет для аналізу даних кваліфікації Формули 1 - Monaco 2018, який читає дані з трьох файлів:
- [`start.log`](src/monaco_qualifying/data/start.log)
- [`end.log`](src/monaco_qualifying/data/end.log)
- [`abbreviations.txt`](src/monaco_qualifying/data/abbreviations.txt)

обчислює найкращі часи кіл, сортує гонщиків за часом кола та виводить звіт, що показує в таблиці топ-15 гонщиків та 
решту, яка не ввійшла до топ-15.

---

## Зміст

- [Посилання проекту](#посилання-проекту)
- [Встановлення](#встановлення)
- [Використання](#використання)
  - [CLI](#cli)
- [Документація](#документація)
- [Приклади](#приклади)
- [Оновлення пакету](#оновлення-пакету)
- [Тестування](#тестування)
- [Структура проекту](#структура-проекту)
- [Пошук проблем](#пошук-проблем)

---

## Посилання проекту

- **Домашня сторінка**: [monaco-qualifying на GitLab]
(https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing)  
- **Випуски**: [Releases]
(https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing/-/releases)  
- **Ліцензія**: [MIT License]
(https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing/-/blob/dev/LICENSE)  
- **Відкрити Issue**: [Створити Issue]
(https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing/-/issues)

---

## Встановлення

```bash
pip install monaco-qualifying
```

---

## Використання

### CLI

- Для виводу повного звіту гонщиків:

```bash
python -m src.monaco_qualifying
```

---

### Документація

1. Відкрити Python-інтерпретатор:

```bash
python
```

1. Імпортувати модуль і викликати `help()`:

```markdown
from .driver_3_version import RecordData
help(RecordData)
```

---

## Приклади

### Приклад звіту

```
1. Sebastian Vettel | FERRARI | 1:4.415
2. Valtteri Bottas | MERCEDES | 1:12.434
3. Stoffel Vandoorne | MCLAREN RENAULT | 1:12.463
...
----------------------------------------------------------------------
16. Daniel Ricciardo | RED BULL RACING TAG HEUER | 2:47.987
17. Sergey Sirotkin | WILLIAMS MERCEDES | 4:47.294
```

## Оновлення пакету

```bash
pip install --upgrade monaco-qualifying
```

---

## Тестування

1. Клонувати репозиторій:

```bash
git clone https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing.git 
cd task_6_report_of_monaco_2018_racing
```

1. Створити середовище та встановити залежності за допомогою `uv`:

```bash
uv venv
uv pip install -r uv.lock
```

1. Використати `ruff` для перевірки стилю коду.

```bash
ruff check .--fix
```

1. Запустити тести:

```bash
pytest
```

---

## Структура проекту

```plaintext
task_6_report_of_monaco_2018_racing/
|-- data/
|   +-- abbreviations.txt
|   +-- end.log
|   +-- start/log
|-- src/
|   +-- monaco_qualifying/
|   |   +-- __init__.py
|   |   +-- driver_3_version.py
|-- tests/
|   +-- __init__.py
|   +-- test_driver.py
|-- .gitignore
|-- .gitlab-ci.yml
|-- LICENSE
|-- main.py
|-- pyproject.toml
|README.md
|--uv.lock
```
---

## Пошук проблем
- Якщо виникли проблеми, створити 
[Issue](https://git.foxminded.ua/liliia-shpytsia-mentoring/task_6_report_of_monaco_2018_racing/-/issues) на GitLab.

---
