CLI tool to track speed skating races
Project description
CLI speed skating race tracker
SkateTracker is a CLI that allows you to track and visualise the progress of an ongoing speed skating competition.
Requirements
The package was tested on a Mac system and on a Linux system. So it should run on those systems.
On Windows installing the package via pip
will give you troubles and probably a headache. The easiest solution
is to clone the directory and run the main script directly or to use WSL 2 (which is the recommended route).
Installation
Install with pip
or any other PyPi package manager:
pip install SkateTracker
Or you can clone this repository and install the CLI directly. It is also possible to install just the requirements and
call the main.py
script directly.
git clone git@github.com:HiddeFok/CLI_speed_skating_tracker.git
First option:
cd CLI_speed_skating_tracker
pip install .
You can check if it is installed correctly by typing:
SkateTracker -h
This should show a help screen with all variables that can be used.
Second option:
cd CLI_speed_skating_tracker
pip install -r requirements.txt
Usage
SkateTracker has several options you can configure before you start:
-
--tournament
,-t
, Which is the name of the tournament where the race is taking place. For example, the Winter Olympics, a World Cup, or a national championship. -
--gender
,-g
, if the race is for the Men or the Women. The options areM
orF
. -
--length
,-l
, the length of the race, for example 1000, 3000, etc. -
--save
,-s
, if the results of each race should be saved to a csv. This will allow you to quit the SkateTracker in between races. The options arey
orn
. WARNING: Right now the results will be saved in a folderskate_data
that will be located in the directory your terminal is currently in.
Two more options are in the making. The first will allow you to set a prediction method. SkateTracker will then predict the final time of the race, depending on all the lap times so far of that athlete. The second option allows you to show all the previous results in the plots as well.
An example initialisation is
SkateTracker -t Winter_Olympics -g F -l 1500
Window size
To have an optimal experience it is recommended to make the window of your terminal large. Some parts of the layout are statically rendered. So, the formatting will not scale with your window size.
Example screen
Acknowledgements
This tool relies heavily on the packages Rich and plotext So, please check them out as well!
Have fun using this tool and if there are any issues/improvements, let me know!
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 SkateTracker-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfdfdab80c59accd6da6ab475f3f2b5742dda9b754e1a7c78944959fd2cbe54f |
|
MD5 | 96005a038dae85a1b411ba3c5f3fc67e |
|
BLAKE2b-256 | 7bff8330ca8b8ca63b611630176112136b78ef9737446ed3c14462af045c3dce |