https://github.com/willtheorangeguy/running-calculator
A running distance and speed command line interface. Measures in metric and imperial units, as well as marathons and half-marathons.
https://github.com/willtheorangeguy/running-calculator
calculator cli hacktoberfest python running
Last synced: 9 months ago
JSON representation
A running distance and speed command line interface. Measures in metric and imperial units, as well as marathons and half-marathons.
- Host: GitHub
- URL: https://github.com/willtheorangeguy/running-calculator
- Owner: willtheorangeguy
- License: gpl-3.0
- Created: 2022-01-31T05:37:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-06T02:28:00.000Z (10 months ago)
- Last Synced: 2025-08-06T04:17:04.348Z (10 months ago)
- Topics: calculator, cli, hacktoberfest, python, running
- Language: Python
- Homepage: http://williamvdg.me/Running-Calculator/
- Size: 1.13 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
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](https://github.com/willtheorangeguy/Running-Calculator/releases/latest) the source code** to run the script from the command line on Windows, macOS and Linux. **This will require [Python](https://www.python.org/downloads/).**
You can **[download](https://github.com/willtheorangeguy/Running-Calculator/releases/latest) 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](https://github.com/willtheorangeguy/Running-Calculator/main/README.md#git), which allows you to clone and run the application, [`pip`](https://github.com/willtheorangeguy/Running-Calculator/main/README.md#pip) to create a command line application, or [Docker](https://github.com/willtheorangeguy/Running-Calculator/main/README.md#docker) to create a container of the application.
### Git
To clone and run this application, you'll need [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:
```bash
# 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](https://pypi.org/project/Running-Calculator/) through `pip`.
```bash
# Install via pip
$ pip install running-calculator
# Run the CLI
$ running-calculator
```
### Docker
You can pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line:
```bash
# 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):**
```text
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](https://github.com/willtheorangeguy/Running-Calculator/tree/main/docs)** and on the **[Wiki](https://github.com/willtheorangeguy/Running-Calculator/wiki)**. If more support is required, please open a **[GitHub Discussion](https://github.com/willtheorangeguy/Running-Calculator/discussions/new)** or join our **[Discord](https://discord.gg/2eBHwHaPWp)**.
## Contributing
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/willtheorangeguy/Running-Calculator/compare).
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
## Changelog
See the [`CHANGELOG`](CHANGELOG.md) 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](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US)
## You may also like...
* [PyWorkout](https://github.com/willtheorangeguy/PyWorkout) - A minimal CLI to keep you inspired during your workout!
* [PyAvatar](https://github.com/willtheorangeguy/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites.
* [Python Logo Widgets](https://github.com/willtheorangeguy/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](https://www.gnu.org/licenses/gpl-3.0.en.html) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/willtheorangeguy/Running-Calculator/blob/main/docs/legal/PRIVACY.md) and [Terms and Conditions](https://github.com/willtheorangeguy/Running-Calculator/blob/main/docs/legal/TERMS.md) for legal information.