Name | report-race JSON |
Version |
0.1.0
JSON |
| download |
home_page | |
Summary | Cli for report of Monaco race. |
upload_time | 2023-02-01 07:59:26 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.9 |
license | |
keywords |
report
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
## Overview
The report package provides command-line interface to get
information about Monaco Race 2019:
* date of the race ;
* start time of the race;
* number of the racers;
* report of the race;
* information about driver;
* list of all racers in the race;
* list of all teams in the race;
* list of all racers in specific team;
## System Requirements
report is written for Python 3. The following
sub-versions are supported:
* Python 3.9
* Python 3.10
## Install
`pip install report`
## CLI Usage Example
For all reports `--files` argument is required.
`--files` argument is path of directory where report files are located.
Example of the report files:
* `abbreviations.txt` (contains information about racer in a form `SVF_Sebastian Vettel_FERRARI`)
* `start.log` (contains Q1 start time of racers in a form `SVF2018-05-24_12:02:58.917`)
* `end.log` (contains Q1 finish time of racers in a form `SVF2018-05-24_12:04:03.332`)
**_NOTE:_** Name of the files and content form should be exactly as in example.
More information about usage
`pyhton -m report.report -h`
Date of the race:
`python -m report.report -f <path> --date`
Start time of the race:
`python -m report.report -f <path> --time`
Number of the racers:
`python -m report.report -f <path> --racers-number`
Report of the race:
`python -m report.report -f <path> --report`
Information about driver:
`python -m report.report -f <path> --driver <full name>`
List of the racers:
`python -m report.report -f <path> --racers <[asc, desc]>`
List of the teams:
`python -m report.report -f <path> --teams <[asc, desc]>`
List of the racers from specific team:
`python -m report.report -f <path> --team-racers <team name>`
**_NOTE:_** More than one argument can be passed in one time. Example:
`python -m report.report -f <path> --report -d -t --racers asc`
Package can be used in your project:
```python
from report_race import race
race_valid = race.LogFilesValidator("path/to/directory")
race = race_valid.init_race()
```
Ande then you can use it like that:
```python
race.get_racer("name_of_the_racer")
race.get_number_of_racers()
```
Raw data
{
"_id": null,
"home_page": "",
"name": "report-race",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "report",
"author": "",
"author_email": "Svjatoslav Matvejev <svjatoslav.matvejev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/02/8d/a007080bc2bc377b602b7c13ac25a3bdb89a5beba0446d2604a912d901c4/report_race-0.1.0.tar.gz",
"platform": null,
"description": "## Overview\n\nThe report package provides command-line interface to get \ninformation about Monaco Race 2019:\n* date of the race ;\n* start time of the race;\n* number of the racers;\n* report of the race;\n* information about driver;\n* list of all racers in the race;\n* list of all teams in the race;\n* list of all racers in specific team;\n\n## System Requirements\n\nreport is written for Python 3. The following\nsub-versions are supported:\n\n* Python 3.9\n* Python 3.10\n\n## Install\n\n`pip install report`\n\n## CLI Usage Example\n\nFor all reports `--files` argument is required.\n`--files` argument is path of directory where report files are located.\nExample of the report files:\n* `abbreviations.txt` (contains information about racer in a form `SVF_Sebastian Vettel_FERRARI`)\n* `start.log` (contains Q1 start time of racers in a form `SVF2018-05-24_12:02:58.917`)\n* `end.log` (contains Q1 finish time of racers in a form `SVF2018-05-24_12:04:03.332`)\n\n**_NOTE:_** Name of the files and content form should be exactly as in example.\n\n\nMore information about usage\n`pyhton -m report.report -h`\n\nDate of the race:\n`python -m report.report -f <path> --date`\n\nStart time of the race:\n`python -m report.report -f <path> --time`\n\nNumber of the racers:\n`python -m report.report -f <path> --racers-number`\n\nReport of the race:\n`python -m report.report -f <path> --report`\n\nInformation about driver:\n`python -m report.report -f <path> --driver <full name>`\n\nList of the racers:\n`python -m report.report -f <path> --racers <[asc, desc]>`\n\nList of the teams:\n`python -m report.report -f <path> --teams <[asc, desc]>`\n\nList of the racers from specific team:\n`python -m report.report -f <path> --team-racers <team name>`\n\n\n**_NOTE:_** More than one argument can be passed in one time. Example:\n`python -m report.report -f <path> --report -d -t --racers asc`\n\n\nPackage can be used in your project:\n```python\nfrom report_race import race\n\nrace_valid = race.LogFilesValidator(\"path/to/directory\")\nrace = race_valid.init_race()\n```\nAnde then you can use it like that:\n```python\nrace.get_racer(\"name_of_the_racer\")\nrace.get_number_of_racers()\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Cli for report of Monaco race.",
"version": "0.1.0",
"split_keywords": [
"report"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "387cf4ea7902ad91b9c411339171040dcc943fe7a9277acb96ae23d8a357d68f",
"md5": "fd0997db460eb6d28e22de05a7af72ed",
"sha256": "b4f7913ed5dd1529308c2f379a1347e9139a956df3fbf4149c6849e960f8cd02"
},
"downloads": -1,
"filename": "report_race-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd0997db460eb6d28e22de05a7af72ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9766,
"upload_time": "2023-02-01T07:59:24",
"upload_time_iso_8601": "2023-02-01T07:59:24.656518Z",
"url": "https://files.pythonhosted.org/packages/38/7c/f4ea7902ad91b9c411339171040dcc943fe7a9277acb96ae23d8a357d68f/report_race-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "028da007080bc2bc377b602b7c13ac25a3bdb89a5beba0446d2604a912d901c4",
"md5": "854bb321c88c69844de7ba4610d5b97e",
"sha256": "4142f2c6402983faa7792385d0f559b5abaf50dab052782f74c0b192c0a1258a"
},
"downloads": -1,
"filename": "report_race-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "854bb321c88c69844de7ba4610d5b97e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 79488,
"upload_time": "2023-02-01T07:59:26",
"upload_time_iso_8601": "2023-02-01T07:59:26.323033Z",
"url": "https://files.pythonhosted.org/packages/02/8d/a007080bc2bc377b602b7c13ac25a3bdb89a5beba0446d2604a912d901c4/report_race-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-01 07:59:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "report-race"
}