A running distance and speed command line interface. Measures in metric and imperial units, as well as marathons and half-marathons.
Project description
Running Calculator
A running distance and speed command line interface! Measures in metric and imperial units, as well as marathons and half-marathons.
Key Features • Download • How To Use • Support • Contributing • Changelog • Credits & Contributors
Key Features
- Easily input distance of a run.
- Input distance can be in marathons, half-marathons, miles, feet, kilometers and meters.
- Easily input run time.
- Displays speeds in meters per second and kilometers per hour.
- Cross platform.
Download
You can download the source code to run the script from the command line on Windows, macOS and Linux. This will require Python.
You can download the latest executable version of Running Calculator for Windows. This does not require Python.
How To Use
To run the application, you can use Git and the Python Interpreter, which allows you to clone and run the application, pip
to create a command line application, or Docker to create a container of the application.
Git
To clone and run this application, you'll need Git and Python installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:
# Clone this repository
$ git clone https://github.com/willtheorangeguy/Running-Calculator
# Go into the repository
$ cd Running-Calculator
# Run the CLI
$ python main.py
pip
You can install the program from the Python Package Index through pip
.
# Install via pip
$ pip install running-calculator
# Run the CLI
$ running-calculator
Docker
You can pull the Docker image from GitHub Packages. From your command line:
# Pull image
$ docker pull ghcr.io/willtheorangeguy/running-calculator:main
# Run container
$ docker run -i -t ghcr.io/willtheorangeguy/running-calculator:main python main.py
Support
The following units are available (can be generated by using the help
command):
Marathons 42195m
Half Marathons 21907.5m
Miles 1069.3m
Feet 0.38m
Kilometers 1000m
Meters 1m
license View the license file.
exit Exit the program.
quit Exit the program.
More documentation is available in the Documentation and on the Wiki. If more support is required, please open a GitHub Discussion or join our Discord.
Contributing
Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.
Please read CONTRIBUTING
for details on our CODE OF CONDUCT
, and the process for submitting pull requests to us.
Changelog
See the CHANGELOG
file for details.
Credits
This software uses the following open source packages, projects, services or websites:
GitHub | Python Software Foundation | PyInstaller | Carbon |
Web - Plans | Web - Donate | Web - Donate | Web |
Contributors
- @willtheorangeguy - Sponsor on PayPal
You may also like...
- PyWorkout - A minimal CLI to keep you inspired during your workout!
- PyAvatar - Easily display all of your creative avatars to keep them consistent across websites.
- Python Logo Widgets - Python Powered Logo widgets that can be added to any GUI project.
License
This project is licensed under the GNU General Public License - see the LICENSE
file for details. See the Privacy Policy and Terms and Conditions for legal information.
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
Built Distribution
Hashes for Running_Calculator-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99b328e0f946588f5a937740e4fd944187581dfc48cb6a3f518619ee0487c2af |
|
MD5 | c9feea2c577b872f96a5818b60a01f7d |
|
BLAKE2b-256 | 10a20b288fa9b7b25352b00ffcc653609d5a4b360297b63f4d0c69bec4fe691b |