A report generation package for results of Monaco 2018 Racing
Project description
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
:
</code></pre>
<h2>Usage</h2>
<p>The package provides a command-line interface with several options.</p>
<h3>Generating a Report</h3>
<p>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 <code>--asc</code> or <code>--desc</code> flag allows you to specify the sorting order (default is ascending).</p>
<pre lang="bash"><code>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.
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
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 file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
report_vp-0.0.6.tar.gz
(10.1 kB
view hashes)
Built Distribution
Close
Hashes for report_vp-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 917c6ee580da8828fcd49dfd990b3386205eafc98e7fca4fe4cbd29652ee4bca |
|
MD5 | 964c0fbd32872f6245e53b3e5fdee342 |
|
BLAKE2b-256 | d4c6070b315bf8952748e3a3c07880c7e658cb3ff59af66aaa5f056d7ef921d1 |