A report generation package for results of Monaco 2018 Racing
Project description
Project description
Module for report generation. Takes logs of start and end time, assing values by key to data from abbrevations.txt and provide records recults.
Installation
To use the package, you need to install it first. You can do this using pip
:
pip install report_volo
A Simple Example
from report_volo import record_report
args = ["--files", "path/to/data_folder", "--asc"]
record_report(args)
Methods:
read_abbr
Reads abbreviations from the specified file, validates the format, and returns a dictionary of Record
objects.
Example:
from report_volo import read_abbr
read_abbr("path/to/folder, records_dict, abbr_file="abbreviations.txt")
read_logs
Reads log files, extracts start and end data, and updates the Record objects accordingly.
Example:
from report_volo import read_logs
read_logs("path/to/folder", records_dict, start_file="start.log", end_file="end.log")
build_report
Compiles and returns two lists of Record objects representing valid and invalid records based on logs and abbreviations.
Example:
from report_volo import build_report
good_records_asc, bad_records = build_report(path=folder_path, order="asc")
print_report
Formats and prints a report based on ordered lists of valid and invalid records.
Example:
from report_volo import print_report
print_report(expected_good_records_asc, expected_bad_records, border_line=15)
cli
Parses command-line arguments using argparse and returns a namespace.
Example:
from report_volo import cli
cli("--files", "path/to/folder", "--asc")
record_report
Orchestrates the report generation process, parsing command-line arguments, generating reports, and printing them.
Example:
from report_volo import record_report
record_report("--files", "path/to/folder", "--asc")
License
This package is licensed under the MIT License - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for report_volo-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67576d9e11c6e5cd2d36da3901087e2639a283bcfc91d5d08eac16ed99846b19 |
|
MD5 | 0b63a4284cee5468bfe1e59420bbca78 |
|
BLAKE2b-256 | 79689eddfefbc06242628368bf8b8d7a67e9bccd06b10650268890cd83229f25 |