Skip to content

PyWorkout — Installation

PyWorkout runs on Windows, macOS, and Linux. There are four ways to install it; pick whichever suits you.

Method Needs Python Best for
pip Yes Most people
Executable No Windows users who do not want to install Python
Source Yes Trying changes or contributing
Docker No Running in a container

Python Package Index (pip)

  1. Install Python 3.9 or newer.
  2. Install PyWorkout:
pip install pyworkout
  1. Run it:
pyworkout

Executable Package

No Python needed — everything is bundled.

  1. Download the latest .zip from Releases.
  2. Extract it with 7-Zip or Windows Explorer.
  3. (Optional) Move the folder to C:\Program Files and make a shortcut.
  4. Run PyWorkout.exe.

From Source

  1. Install Python 3.9 or newer and Git.
  2. Clone and run:
git clone https://github.com/willtheorangeguy/PyWorkout
cd PyWorkout
python main.py

No pip install step is required — PyWorkout uses only the standard library.

If you would rather not use Git, download the source archive from Releases and run python main.py inside the extracted folder.

Docker Container

  1. Install Docker.
  2. Pull the image from GitHub Packages:
docker pull ghcr.io/willtheorangeguy/pyworkout:main
  1. Run it interactively — -i -t matters, because PyWorkout reads commands from stdin:
docker run -i -t ghcr.io/willtheorangeguy/pyworkout:main python main.py

The video command will not work inside a container, since it has no access to your local video files or a media player.

Next Steps

Head to Usage to run your first workout, or Configuration to make it yours.