Skip to content

This program will provide visual cues in the CLI for the box breathing technique, and allow people to follow along with their breath to assist them in their mindful breathing practice.

License

Notifications You must be signed in to change notification settings

xjwllmsx/BoxBreathing

BoxBreathing

Introduction

Life can get busy, stressful and chaotic at times. In those moments, it’s important to remember to not focus on external forces, but to instead focus on our inner energy. Mindful breathing can help people de-stress, slow down the nervous system, increase concentration and many other physiological and psychological benefits. However, some people have difficulty focusing on their breath and struggle with mindful breathing. This program will provide visual cues for the box breathing technique, and allow people to follow along with their breath to assist them in their mindful breathing practice.

Contents

Features

  • Visual breathing cues for inhale, hold, exhale, and pause.
  • Simple and user-friendly interface.
  • Built for anyone looking to practice mindful breathing.

Requirements

  • Python 3.8 or later

How to Use

You can run the BoxBreathing app in two ways:

Option 1: Run Locally

  1. Clone the repository:
git clone https://github.com/xjwllmsx/BoxBreathing.git
cd BoxBreathing
  1. Run the program:
python boxbreathing.py 
  1. Follow the prompts:
  • Input how many rounds of mindful breathing you would like to do.

  • Type the word start when you are ready to begin your practice.

  • The program will provide prompts ("inhale", "hold", "exhale", "hold") and countdown timers for each step.

  • After completing your rounds, you will have the option to initiate additional rounds or end the session.

Option 2: Try It Online (via Binder)

You can run the BoxBreathing app directly in your browser using Binder — no installation needed.

Launch Binder

Click the badge above to launch the app in Binder.

How to use Binder:

  1. Click the Binder badge.

  2. Wait for the environment to load (this may take a minute).

  3. Open the box_breathing_demo.ipynb notebook.

  4. Run the cells to start the breathing exercise.

  5. When prompted, enter the number of breathing cycles you would like to complete and follow along.

NOTE: Binder sessions are temporary. If you close the window, your session will end.

Acknowledgement

Thank you for checking out my program. I hope you enjoy it as much as I enjoyed creating it.

License

This project is licensed under the MIT License.

About

This program will provide visual cues in the CLI for the box breathing technique, and allow people to follow along with their breath to assist them in their mindful breathing practice.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  
  •  
  •