| Name | task-6-rakitin-sergey JSON |
| Version |
0.0.26
JSON |
| download |
| home_page | None |
| Summary | A package for processing Formula 1 racing logs |
| upload_time | 2024-10-20 12:20:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
formula 1
logs
racing
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# F1 Racing Report Package
This Python package generates and prints a report for Formula 1 racing, based on logs of start and end times of racers. The package also provides a command-line interface (CLI) to interact with the report generation and allows flexible configuration options.
## Features
- **Report Generation**: Generate a sorted list of F1 racers by lap times.
- **CLI Interface**: Process files from a specified folder and print reports or errors.
- **Error Handling**: Provides detailed error messages for problematic records (e.g., invalid times).
- **Custom Report Options**: Includes optional sorting and underline settings.
## Installation
Install the package using PIP:
```bash
pip install task_6_rakitin_sergey
```
# Usage
Enter the following commands via CMD.
## Below are some examples of how to use the CLI.
Basic Report generation (with ascending order by default):
```bash
python -m task_6_rakitin_sergey.f1_report
```
Generate report with sorting order descending:
```bash
python -m task_6_rakitin_sergey.f1_report --order desc
```
Print report with custom underline after a specific line (for example, 3):
```bash
python -m task_6_rakitin_sergey.f1_report --underline_after 3
```
Show only errors:
```bash
python -m task_6_rakitin_sergey.f1_report --errors_only
```
Show report for a specific driver:
```bash
python -m task_6_rakitin_sergey.f1_report --driver "Sebastian Vettel"
```
Use an own path to .log and .txt files:
```bash
python -m task_6_rakitin_sergey.f1_report --files <folder_path>
```
List of commands:
```bash
python -m task_6_rakitin_sergey.f1_report --help
```
Import package to your project and call:
```bash
from task_6_rakitin_sergey import f1_report
if __name__ == "__main__":
f1_report.command_line_input()
```
## Link to package page
```Bash
https://pypi.org/project/task-6-rakitin-sergey/
```
Raw data
{
"_id": null,
"home_page": null,
"name": "task-6-rakitin-sergey",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Formula 1, logs, racing",
"author": null,
"author_email": "Rakitin Sergey <dronyx@inbox.ru>",
"download_url": "https://files.pythonhosted.org/packages/87/e3/02ee3d97959fea432305c55477cea4602bb756c3d9a5bd63d2701873bf14/task_6_rakitin_sergey-0.0.26.tar.gz",
"platform": null,
"description": "# F1 Racing Report Package\n\nThis Python package generates and prints a report for Formula 1 racing, based on logs of start and end times of racers. The package also provides a command-line interface (CLI) to interact with the report generation and allows flexible configuration options.\n\n## Features\n\n- **Report Generation**: Generate a sorted list of F1 racers by lap times.\n- **CLI Interface**: Process files from a specified folder and print reports or errors.\n- **Error Handling**: Provides detailed error messages for problematic records (e.g., invalid times).\n- **Custom Report Options**: Includes optional sorting and underline settings.\n\n## Installation\n\nInstall the package using PIP:\n\n```bash\n pip install task_6_rakitin_sergey\n```\n# Usage\n\nEnter the following commands via CMD.\n\n## Below are some examples of how to use the CLI.\n\nBasic Report generation (with ascending order by default):\n\n```bash\n python -m task_6_rakitin_sergey.f1_report\n```\n\nGenerate report with sorting order descending:\n\n```bash\n python -m task_6_rakitin_sergey.f1_report --order desc\n```\n\nPrint report with custom underline after a specific line (for example, 3):\n\n```bash\n python -m task_6_rakitin_sergey.f1_report --underline_after 3\n```\n\nShow only errors:\n\n```bash\n python -m task_6_rakitin_sergey.f1_report --errors_only\n```\n\nShow report for a specific driver:\n\n```bash\n python -m task_6_rakitin_sergey.f1_report --driver \"Sebastian Vettel\"\n```\n\nUse an own path to .log and .txt files:\n\n```bash\n python -m task_6_rakitin_sergey.f1_report --files <folder_path>\n```\n\nList of commands:\n\n```bash\n python -m task_6_rakitin_sergey.f1_report --help\n```\n\nImport package to your project and call:\n\n```bash\n from task_6_rakitin_sergey import f1_report\n\n if __name__ == \"__main__\":\n f1_report.command_line_input()\n```\n\n## Link to package page \n\n```Bash\n https://pypi.org/project/task-6-rakitin-sergey/\n```\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for processing Formula 1 racing logs",
"version": "0.0.26",
"project_urls": null,
"split_keywords": [
"formula 1",
" logs",
" racing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d053efccfbde03b446b3e9e7ba77173f8714195c44fb0b49561206c43e5a4ac",
"md5": "6b14bf82f843a2454681a2a88424754b",
"sha256": "8cc4a199e3f67820483168758422bab1ee6395aa08269a609d821d08ce1787e1"
},
"downloads": -1,
"filename": "task_6_rakitin_sergey-0.0.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b14bf82f843a2454681a2a88424754b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7776,
"upload_time": "2024-10-20T12:20:02",
"upload_time_iso_8601": "2024-10-20T12:20:02.706265Z",
"url": "https://files.pythonhosted.org/packages/0d/05/3efccfbde03b446b3e9e7ba77173f8714195c44fb0b49561206c43e5a4ac/task_6_rakitin_sergey-0.0.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "87e302ee3d97959fea432305c55477cea4602bb756c3d9a5bd63d2701873bf14",
"md5": "57885fef09ae558af8b1635582023e43",
"sha256": "4079961e5ded10c4101b13e2a04226c5e75acc1b57f999427777ace20a7b0090"
},
"downloads": -1,
"filename": "task_6_rakitin_sergey-0.0.26.tar.gz",
"has_sig": false,
"md5_digest": "57885fef09ae558af8b1635582023e43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9490,
"upload_time": "2024-10-20T12:20:10",
"upload_time_iso_8601": "2024-10-20T12:20:10.382704Z",
"url": "https://files.pythonhosted.org/packages/87/e3/02ee3d97959fea432305c55477cea4602bb756c3d9a5bd63d2701873bf14/task_6_rakitin_sergey-0.0.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 12:20:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "task-6-rakitin-sergey"
}
