Metadata-Version: 2.1
Name: routinemaker
Version: 0.5.3
Summary: A Python CLI that generates strength, cardio, and HIIT exercise routines using parametric curves
Home-page: https://github.com/kathyqian/routinemaker
Author: Kathy Qian
Author-email: hello@kathyqian.com
License: MIT
Description: # Routinemaker
        
        Routinemaker is a Python CLI that generates strength, cardio, and HIIT exercise routines using parametric curves. Routines are saved as Excel spreadsheets. See [routinemaker.me](https://routinemaker.me) for documentation.
        
        ## Installation
        
        Routinemaker is a Python 3 package and can be installed through `pip`.
        
        `$ pip install routinemaker`
        
        ## Usage
        
        Run Routinemaker from the command line. The command does not take any options. You will be prompted as the generator walks through all the options.
        
        `$ routinemaker`
        
        ## Outputs
        
        Routinemaker generates formatted Excel spreadsheets. You can either print out the spreadsheets or upload them to the cloud (ie: Google Drive) to make them easier to use during workouts. Below are screenshots, downloadable files, and a brief usage guide for sample routines.
        
        ### Strength ([download](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/xlsx/strength.xlsx))
        
        _Usage:_ On Day 1, do 2 sets of 5 reps of dumbbell goblet squats with 50 pounds of weight, then do 2 sets of 3 reps of barbell bench presses with 20 pounds of weight. Mark an "X" in the corresponding white box as you finish each set.
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/strength.png)
        
        ### Cardio ([download](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/xlsx/cardio.xlsx))
        
        _Usage:_ On Day 1, run for 2.5 minutes, then rest by walking. Next, run for 1.5 minutes, then rest by walking. Finish all 6 intervals and mark an "X" in the corresponding white box as you progress.
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/cardio.png)
        
        ### HIIT ([download](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/xlsx/HIIT.xlsx))
        
        _Usage:_ On Day 1, do 2 sets of 9 reps of bodyweight side lunges for each side, then do 2 sets of 5 reps of bodyweight jump squats, then do 2 sets of 10-second bodyweight forearm planks. Mark an "X" in the corresponding white box as you finish each set.
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/HIIT.png)
        
        ## Customizations
        
        Routinemake is meant to be customized to your preferences. In particular, you may want to modify the list of exercises or tweak the equations for the curves used to generate the workouts.
        
        ### Exercises
        
        You can customize the list of exercises that Routinemaker uses to generate workouts. The exercises are stored in `data/exercises.json`. Each exercise in the json file includes settings for _type_ (ie: strength), muscle _group_ (ie: chest), _variations_ (ie: by equipment), _unit_ of measurement (ie: reps or seconds), _minimum_ units, _maximum_ units, and the _step_ for incrementing the units.
        
        ### Curves
        
        You can also customize the curves that Routinemaker uses to generate workouts. The calculation logic is stored in `routine.py`. Routinemaker comes with 3 default curves: _linear_ (constant increase in difficulty), _exponential_ (starts off easy and escalates in difficulty towards the end), and _logarithmic_ (ramps up quickly).
        
        ## Workflow
        
        Routinemaker works by prompting for a variety of settings and then feeding the parameters into curves in order to generate workouts for each day. Below are a few sample screenshots of the workflow and a summary of all the prompts and options.
        
        ### Splash Screen
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/splashscreen.png)
        
        ### Filtering Equipment for Strength Exercises
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/equipment.png)
        
        ### Manually Selecting Strength Exercises
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/manualstrength.png)
        
        ### Choosing Random List of HIIT Exercises
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/randomHIIT.png)
        
        ### Editing Cart of Exercises
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/editcart.png)
        
        ### Choosing Goals for Strength Exercises
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/strengthgoals.png)
        
        ### Configuring Intervals for Cardio Exercises
        
        ![](https://raw.githubusercontent.com/kathyqian/routinemaker/master/docs/img/configurecardio.png)
        
        ### Summary of Prompts and Options
        
        ```
        ├── What type of routine do you want to create?
        │    ├── STRENGTH
        │    │    ├── What type of equipment do you have access to?
        │    │    └── How would you like to choose the exercises for your routine?
        │    │         ├── START WITH A RANDOM LIST OF EXERCISES
        │    │         │    ├── Which muscle groups do you want to train?
        │    │         │    └── How many exercises do you want in your routine?
        │    │         └── MANUALLY ADD EXERCISES [∞]
        │    │              ├── Pick a muscle group to browse exercises to add
        │    │              └── Which exercise would you like to add?
        │    ├── CARDIO
        │    │    └── Which cardio activity would you like to do?
        │    │         └── Which specific exercise would you like to work on?
        │    └── HIIT
        │         └── How would you like to choose the exercises for your routine?
        │              ├── START WITH A RANDOM LIST OF EXERCISES
        │              │    ├── Which muscle groups do you want to train?
        │              │    └── How many exercises do you want in your routine?
        │              └── MANUALLY ADD EXERCISES [∞]
        │                   ├── Pick a muscle group to browse exercises to add
        │                   └── Which exercise would you like to add?
        ├── Do you need to edit or reorder the exercises in your routine? [∞]
        │    ├── YES
        │    │    └── What would you like to do?
        │    │         ├── ADD EXERCISE
        │    │         │    ├── Pick a muscle group to browse exercises to add
        │    │         │    └── Which exercise would you like to add?
        │    │         ├── REMOVE EXERCISE
        │    │         │    └── Which exercise would you like to remove?
        │    │         ├── SWAP EXERCISE
        │    │         │    ├── Which exercise would you like to swap?
        │    │         │    ├── [STRENGTH/HIIT]
        │    │         │    │    ├── Pick a muscle group to browse exercises to add
        │    │         │    │    └── Which exercise would you like to add?
        │    │         │    └── [CARDIO]
        │    │         │         └── Which exercise would you like to add?
        │    │         └── REORDER EXERCISE
        │    │              ├── Which exercise would you like to move?
        │    │              └── Which exercise would you like to move it before?
        │    └── NO
        ├── How many weeks would you like your routine to last?
        ├── How many days per week are you planning on exercising?
        ├── [FOR EACH EXERCISE]
        │    ├── Which variation of EXERCISE do you plan on doing?
        │    ├── How many continuous UNITS of ACTIVITY are you currently comfortable with?
        │    ├── How many continuous UNITS of ACTIVITY is your goal?
        │    └── [STRENGTH]
        │         ├── What weight are you currently using for ACTIVITY?
        │         └── What's your goal weight for ACTIVITY?
        ├── [STRENGTH/HIIT]
        │    ├── What's the mininum number of sets you'd like to do for each exercise?
        │    └── What's the maximum number of sets you'd like to do for each exercise?
        ├── [CARDIO]
        │    ├── What's the maximum number of intervals you want in your routine?
        │    └── Please choose a random number to seed the routine
        ├── What type of curve do you want to use to create your routine?
        │    ├── LINEAR
        │    ├── EXPONENTIAL
        │    └── LOGARITHMIC
        └── What do you want to name the output file?
        ```
        
        ## Disclaimer
        
        Routinemaker is an automated engine that generates workout routines independent of your physical ability. Generated workouts may not be suitable for your level of fitness. Please use common sense. You should see your healthcare provider before starting a new exercise program.
        
        ## License
        
        Routinemaker was created and [open-sourced](https://github.com/kathyqian/routinemaker) under the [MIT License](https://github.com/kathyqian/routinemaker/blob/master/LICENSE) by [Kathy Qian](https://kathyqian.com/).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
