Skip to content

Repository files navigation

PyWorkout
PyWorkout

A minimal CLI to keep you inspired during your workout.

Tests Pylint Docker Build PyPI Build CodeQL Version Issues Pull Requests License

Key FeaturesInstallationUsageDocumentationSupportContributingLicense

PyWorkout running in a terminal

Key Features

  • Pick a muscle group and get walked through the workout one exercise at a time.
  • Nine muscle groups covering the whole body, each with its own set and rep counts.
  • Live elapsed time and percent complete after every exercise.
  • Skip anything you would rather not do, and see full statistics at the end.
  • Open a local video for the current muscle group with one command.
  • Add exercises, change rep counts, and swap videos by editing plain Python lists.
  • No runtime dependencies beyond the standard library. Runs on Windows, macOS, and Linux.

Installation

pip install pyworkout

Prefer a standalone Windows executable, the source, or a container? See Installation.

Usage

Start the CLI, choose a muscle group, then step through the workout:

$ pyworkout
Which muscle group would you like to work out? abs

> start
You have started the abs muscle group.
The current time is: 14:19:35
You have completed: 0%
Please complete 2 Sets of 25 Reps of Situps

> next
You have completed: 16%
Please complete 2 Sets of 25 Reps of Reverse Crunches

> end

help lists every command. The full reference is in Commands.

Documentation

Full documentation lives in docs/: Quickstart · Installation · Usage · Commands · Configuration · Architecture · FAQ · Troubleshooting · Roadmap

Support

Open a GitHub Discussion or file an issue.

Contributing

Contributions welcome. See the org-wide Contributing Guide and Code of Conduct.

Credits

Built with Python, packaged with PyInstaller, and distributed through PyPI and GitHub Packages.

License

MIT — see LICENSE.md.

About

A minimal CLI to keep you inspired during your workout! Easily used and customized, with support for multiple workout plans, different muscle groups and video workouts.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

5 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages