Skip to main content

A command-line tool designed to help you relax from your terminal.

Project description

Deep Breath CLI

Deep Breath CLI is a command-line tool designed to help you relax, regain focus, and boost your energy—right from your terminal.

🌬️ What is Deep Breath CLI?

Whether you're coding, studying, or just need a quick break, Deep Breath CLI offers guided breathing exercises with visual progress bars and calming colors. With simple commands, you can access different breathing patterns to help you reset and recharge.

🚀 Features

  • Multiple breathing patterns (4-7-8, Box breathing)
  • Visual progress bars with calming colors
  • Customizable session lengths and cycles
  • Clear, distraction-free interface
  • Easy preset management

🛠️ Installation

Install from PyPI:

pip install deep-breath-cli

⚡️ Usage

Start a breathing session

# Default session (4 cycles of 4-7-8 pattern)
breath start

# Custom number of cycles
breath start --cycle 8

# Different breathing pattern
breath start --pattern "4-4-4-4"

# Combined options
breath start --cycle 6 --pattern "4-4-4-4"

View available patterns

breath presets

Output:

Available breathing patterns:
  4-7-8: 4s Breathe in..., 7s Hold..., 8s Breathe out...
  4-4-4-4: 4s Breathe in..., 4s Hold..., 4s Breathe out..., 4s Hold...

You can use these patterns with the --pattern option.

Get help

breath --help
breath start --help

🌟 Breathing Patterns

  • 4-7-8: Relaxation pattern (inhale 4s, hold 7s, exhale 8s)
  • 4-4-4-4: Box breathing for focus (inhale 4s, hold 4s, exhale 4s, hold 4s)
  • More to come

🤔 Why use Deep Breath CLI?

  • Quick: Take a break without leaving your terminal
  • Effective: Scientifically-backed breathing techniques
  • Customizable: Choose the pattern and duration that fits your needs
  • Distraction-free: Clear your mind with simple, focused interface

🛠️ Development

Setup

git clone https://github.com/weart99/deep-breath-cli
cd deep-breath-cli
uv sync --extra dev

Running tests

uv run pytest tests/ --cov=src

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and ensure they pass
  5. Submit a pull request

📄 License

MIT Licence MIT License

Authors

@weart99


Take a deep breath, and let's get started! 🌬️

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deep_breath_cli-0.1.1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deep_breath_cli-0.1.1-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file deep_breath_cli-0.1.1.tar.gz.

File metadata

  • Download URL: deep_breath_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for deep_breath_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 06649f988a8ff12f1ff6d0e04e550216115555a764c0f553977c1f33488e709f
MD5 ec600d636c7a2e4192e1d49a63a6395d
BLAKE2b-256 01635177782e9176533014b3b97f93ce6ce38d222b5cf9e64bef4c42b2889388

See more details on using hashes here.

File details

Details for the file deep_breath_cli-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for deep_breath_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 059a088642f390509a03b7053284ed86c0b5aa0c6fa84eff8f04bf4c9d8ba9ba
MD5 3eaf7daa6efdd9755643231d638560ea
BLAKE2b-256 7af4030895356b977c0ff9bf1f0c356af63f3a9dbf07e6aa918dd5d155ce23c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page