An open API service indexing awesome lists of open source software.

https://github.com/sepandhaghighi/nafas

🧘‍♂️ Breathing Gymnastics Application
https://github.com/sepandhaghighi/nafas

application breath breathing calm cli cli-app entertainment fun geeks health healthcare meditation mental-health nerds python python3 yoga

Last synced: 10 months ago
JSON representation

🧘‍♂️ Breathing Gymnastics Application

Awesome Lists containing this project

README

          



Nafas: A Breathing Gymnastics Application




PyPI version
Codecov
built with Python3
GitHub repo size
Discord Channel


## Overview
Breathing gymnastics is a system of breathing exercises that focuses on the treatment of various diseases and general health promotion.
**Nafas** is a collection of breathing gymnastics designed to reduce the exhaustion of long working hours.
With multiple breathing patterns, **Nafas** helps you find your way to a detoxified energetic workday and also improves your concentration by increasing the oxygen level.
No need to walk away to take a break, just sit comfortably, run **Nafas** and let the journey begin.
**Nafas** means breath in Persian.

**Nafas** offers a selection of predefined breathing exercise programs.
Each program consists of multiple cycles.
The exercises begin with a gentle preparation phase to help users settle in and focus, followed by a series of timed inhales and exhales.
Between these breaths, the programs incorporate deliberate pauses that allow users to retain and sustain their breath.
These cycles aim to enhance both physical and mental well-being.


Nafas Programs' Cycle

Nafas Programs' Cycle



Open Hub



PyPI Counter



Github Stars


Branch
master
dev


CI



Code Quality

CodeFactor

## Installation

### Source Code
- Download [Version 1.4](https://github.com/sepandhaghighi/nafas/archive/v1.4.zip) or [Latest Source](https://github.com/sepandhaghighi/nafas/archive/dev.zip)
- `pip install .`

### PyPI

- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- `pip install nafas==1.4`

### Exe Version

⚠️ Only Windows

- Download [Exe-Version 1.4](https://github.com/sepandhaghighi/nafas/releases/download/v1.4/NAFAS-1.4.exe)
- Run `NAFAS-1.4.exe`

## Usage

ℹ️ You can use `nafas`, `python -m nafas` or `NAFAS.exe` to run this program

ℹ️ Checkout the available programs in [PROGRAMS.md](https://github.com/sepandhaghighi/nafas/blob/master/PROGRAMS.md)

### Version

```console
nafas --version
```

### Basic

```console
nafas
```

### Silent Mode

ℹ️ This mode will disable the sound playing system

```console
nafas --silent
```

### Speaker

ℹ️ Customize your experience by choosing from a set of speaker voices to guide you through the exercises.
You can specify the speaker using the `--speaker`:

```console
nafas --speaker=us1
```

Choose your speaker from the following list:
| ID | Description |
|:--:|:-----------:|
| `us1` | Feminine voice with a US accent |
| `us2` | Masculine voice with a US accent |
| `in1` | Feminine voice with an Indian accent |
| `in2` | Masculine voice with an Indian accent |
| `cn1` | Feminine voice with a Chinese accent |
| `cn2` | Masculine voice with a Chinese accent |
| `ca1` | Feminine voice with a Canadian accent |
| `ca2` | Masculine voice with a Canadian accent |
| `au1` | Feminine voice with an Australian accent |
| `au2` | Masculine voice with an Australian accent |
| `uk1` | Feminine voice with a British accent |
| `uk2` | Masculine voice with a British accent |

### Skip Intro

ℹ️ This mode will skip the introduction

```console
nafas --skip-intro
```

### Custom Config

ℹ️ Users can load their custom configurations

```console
nafas --config="program1.json"
```

Config example:

```json
{
"name": "program1",
"unit": 2,
"pre": 3,
"cycle": 10,
"ratio": {
"inhale": 2,
"exhale": 2,
"retain": 3,
"sustain": 4
}
}
```

## Screen Record

Screen Record

## Issues & Bug Reports

Just fill an issue and describe it. We'll check it ASAP!

- Please complete the issue template

You can also join our discord server


Discord Channel

## References

1- Prana Breath

2- Rickard, Kathleen Benjamin, Dorothy J. Dunn, and Virginia M. Brouch. "Breathing techniques associated with improved health outcomes." (2015).

3- Zaccaro, Andrea, Andrea Piarulli, Marco Laurino, Erika Garbella, Danilo Menicucci, Bruno Neri, and Angelo Gemignani. "How breath-control can change your life: a systematic review on psycho-physiological correlates of slow breathing." Frontiers in human neuroscience 12 (2018): 353.

4- Brook, Robert D., Lawrence J. Appel, Melvyn Rubenfire, Gbenga Ogedegbe, John D. Bisognano, William J. Elliott, Flavio D. Fuchs et al. "Beyond medications and diet: alternative approaches to lowering blood pressure: a scientific statement from the American Heart Association." Hypertension 61, no. 6 (2013): 1360-1383.

5- Russo, Marc A., Danielle M. Santarelli, and Dean O’Rourke. "The physiological effects of slow breathing in the healthy human." Breathe 13, no. 4 (2017): 298-309.

6- Bujatti, M., and P. Biederer. "Serotonin, noradrenaline, dopamine metabolites in transcendental meditation-technique." Journal of Neural Transmission 39, no. 3 (1976): 257-267.

7- Martarelli, Daniele, Mario Cocchioni, Stefania Scuri, and Pierluigi Pompei. "Diaphragmatic breathing reduces exercise-induced oxidative stress." Evidence-Based Complementary and Alternative Medicine 2011 (2011).

8- DrWeil, Integrative Medicine & Healthy Living

9- Human Givens Institute

10- This 2-Minute Breathing Exercise Can Help You Make Better Decisions

11- Using 5-5-5 Breathing to Calm Down


12- Free Text-To-Speech and Text-to-MP3 for US English

13- Pranayama Breathing Techniques and Tips

14- Box Breathing Benefits and Techniques

15- Box breathing: How to do it, benefits, and tips

16- Breathing at a rate of 5.5 breaths per minute with equal inhalation-to-exhalation ratio increases heart rate variability

17- Coherent Breathing Timer - 6 Breaths Per Minute | 5 Seconds in / 5 Seconds Out | With Bells

## Cite

If you use **Nafas** in your research, we would appreciate citations to the following paper:

[Sabouri, Sadra, and Sepand Haghighi. "Nafas: Breathing Gymnastics Application." *arXiv preprint arXiv:2412.04667* (2024).](https://arxiv.org/abs/2412.04667)

```bibtex
@article{sabouri2024nafas,
title={Nafas: Breathing Gymnastics Application},
author={Sabouri, Sadra and Haghighi, Sepand},
journal={arXiv preprint arXiv:2412.04667},
year={2024}
}
```

## Show Your Support

Star This Repo

Give a ⭐️ if this project helped you!

Donate to Our Project

Bitcoin


1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy

Ethereum


0xcD4Db18B6664A9662123D4307B074aE968535388

Litecoin


Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ

Doge


DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh

Tron


TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7

Ripple


rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq

Binance Coin


bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef

Tether


0xcD4Db18B6664A9662123D4307B074aE968535388

Dash


Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s

Stellar


GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL

Zilliqa


zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5

Coffeete