| Name | report-VOLO JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | |
| Summary | A report generation package for results of Monaco 2018 Racing |
| upload_time | 2024-02-27 02:36:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11.4 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Formula 1 Monaco 2018 Racing Report Generator
This Python package provides a tool for generating reports based on the start and end data of the best lap for each racer of Formula 1 - Monaco 2018 Racing during the first stage of the qualification (Q1).
## Installation
To use the package, you need to install it first. You can do this using `pip`:
```UPDATE LATER
```
## Usage
The package provides a command-line interface with several options.
### Generating a Report
You can generate a report for the first 20 minutes of the Monaco 2018 Racing by providing the path to the folder containing the data files. The `--asc` or `--desc` flag allows you to specify the sorting order (default is ascending).
```bash (update later)
report.py --files <folder_path> [--asc | --desc]
```
### Driver Statistics
To get statistics about a specific driver, use the `--driver` option along with the folder path.
```bash
report.py --files <folder_path> --driver "Sebastian Vettel"
```
## Package Structure
The package consists of the following components:
- **`Record` Class:** Represents a racer record with start and end times.
- **`FileNotFound` Exception:** Raised when a specified file is not found.
- **`ReportInvalidOrder` Exception:** Raised for an invalid sorting order in the report.
- **`build_report` Function:** Compiles a report summarizing valid and invalid records.
- **`print_report` Function:** Prints a formatted report based on ordered results.
- **`cli` Function:** Parses command-line arguments and orchestrates the report generation process.
## Example
```python
import report.py
#(update later)
# Command-line interface
args = formula1_report.Record.cli()
# Build the report
good_records, bad_records = formula1_report.Record.build_report(args.files, args.sort)
# Filter records if a specific driver is provided
if args.driver:
good_records = [rec for rec in good_records if rec.driver == args.driver]
bad_records = [rec for rec in bad_records if rec.driver == args.driver]
# Print the report
print(report.Record.print_report(good_records, bad_records))
```
## License
This package is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "report-VOLO",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11.4",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Volodymyr Perehuda <author@example.com>",
"download_url": "https://files.pythonhosted.org/packages/dc/42/0154a3f120cafbb9e05f32ee046173f04222f99243ae92dc0a955b5963e4/report_volo-0.0.8.tar.gz",
"platform": null,
"description": "# Formula 1 Monaco 2018 Racing Report Generator\n\nThis Python package provides a tool for generating reports based on the start and end data of the best lap for each racer of Formula 1 - Monaco 2018 Racing during the first stage of the qualification (Q1).\n\n## Installation\n\nTo use the package, you need to install it first. You can do this using `pip`:\n\n```UPDATE LATER\n```\n\n## Usage\n\nThe package provides a command-line interface with several options.\n\n### Generating a Report\n\nYou can generate a report for the first 20 minutes of the Monaco 2018 Racing by providing the path to the folder containing the data files. The `--asc` or `--desc` flag allows you to specify the sorting order (default is ascending).\n\n```bash (update later)\nreport.py --files <folder_path> [--asc | --desc]\n```\n\n### Driver Statistics\n\nTo get statistics about a specific driver, use the `--driver` option along with the folder path.\n\n```bash\nreport.py --files <folder_path> --driver \"Sebastian Vettel\"\n```\n\n## Package Structure\n\nThe package consists of the following components:\n\n- **`Record` Class:** Represents a racer record with start and end times.\n- **`FileNotFound` Exception:** Raised when a specified file is not found.\n- **`ReportInvalidOrder` Exception:** Raised for an invalid sorting order in the report.\n- **`build_report` Function:** Compiles a report summarizing valid and invalid records.\n- **`print_report` Function:** Prints a formatted report based on ordered results.\n- **`cli` Function:** Parses command-line arguments and orchestrates the report generation process.\n\n## Example\n\n```python\nimport report.py\n#(update later)\n# Command-line interface\nargs = formula1_report.Record.cli()\n\n# Build the report\ngood_records, bad_records = formula1_report.Record.build_report(args.files, args.sort)\n\n# Filter records if a specific driver is provided\nif args.driver:\n good_records = [rec for rec in good_records if rec.driver == args.driver]\n bad_records = [rec for rec in bad_records if rec.driver == args.driver]\n\n# Print the report\nprint(report.Record.print_report(good_records, bad_records))\n```\n\n## License\n\nThis package is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "",
"summary": "A report generation package for results of Monaco 2018 Racing",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://git.foxminded.ua/volodymyr-perehuda-nyc/task-6-report-of-monaco-2018-racing",
"Issues": "https://git.foxminded.ua/volodymyr-perehuda-nyc/task-6-report-of-monaco-2018-racing/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d5d4436f9b9f951560f2bb736aefa31095fd5dd3e3fec22ccc7fe190a3665b6",
"md5": "9ccf563f0d334ec2cf8fdcce7fd14c11",
"sha256": "7956ab2267e4e48e6aef86e4d787a94a9698e56594bc68231135721715e8c5ee"
},
"downloads": -1,
"filename": "report_volo-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ccf563f0d334ec2cf8fdcce7fd14c11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.4",
"size": 5111,
"upload_time": "2024-02-27T02:36:10",
"upload_time_iso_8601": "2024-02-27T02:36:10.711852Z",
"url": "https://files.pythonhosted.org/packages/2d/5d/4436f9b9f951560f2bb736aefa31095fd5dd3e3fec22ccc7fe190a3665b6/report_volo-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc420154a3f120cafbb9e05f32ee046173f04222f99243ae92dc0a955b5963e4",
"md5": "922afb2dcbf93abdd336c62578afe75b",
"sha256": "9a4f8c47f6ae1e1fbbbf5f74ad87032c8aafae9c1dcd40beae0bf6bf8d12738a"
},
"downloads": -1,
"filename": "report_volo-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "922afb2dcbf93abdd336c62578afe75b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.4",
"size": 9982,
"upload_time": "2024-02-27T02:36:11",
"upload_time_iso_8601": "2024-02-27T02:36:11.968707Z",
"url": "https://files.pythonhosted.org/packages/dc/42/0154a3f120cafbb9e05f32ee046173f04222f99243ae92dc0a955b5963e4/report_volo-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 02:36:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "report-volo"
}
