Merge pull request #27 from sepandhaghighi/dev

Version 0.2

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+        python-version: [3.5, 3.6, 3.7, 3.8, 3.9]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install requirements
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: First test
+      run: |
+        python setup.py install
+        python -m nafas test
+    - name: Install dev-requirements
+      run: |
+        pip install --upgrade --upgrade-strategy=only-if-needed -r dev-requirements.txt
+    - name: Version check
+      run: |
+        python otherfiles/version_check.py
+    - name: Test with pytest
+      run: |
+        python -m pytest test --cov=nafas --cov-report=term
+    - name: Other tests
+      run: |
+        python -m vulture nafas/ setup.py --min-confidence 65 --exclude=__init__.py --sort-by-size
+        python -m bandit -r nafas -s B311
+        python -m pydocstyle --match-dir=nafas -v
+    - name: Codecov
+      run: |
+        codecov

CHANGELOG.md

@@ -5,6 +5,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.2] - 2021-01-29
+### Added
+- `_playsound_async` function
+- `play_sound` function
+- `inhale.wav`
+- `exhale.wav`
+- `sustain.wav`
+- `retain.wav`
+- `get_sound_path` function
+- `program_description_print` function
+- `time_convert` function
+### Changed
+- Menu optimized
+- Test system modified
+- `get_program_dict` function renamed to `get_program_data`
+- `program_dict` parameter renamed to `program_data`
+- `input_dict` parameter renamed to `input_data`
+- `README.md` updated
 ## [0.1] - 2020-10-30
 ### Added
 - Clear Mind program
@@ -15,7 +33,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Anti-Appetite program 
 - Cigarette Replace program
 
-[Unreleased]: https://github.com/sepandhaghighi/nafas/compare/v0.1...dev
+[Unreleased]: https://github.com/sepandhaghighi/nafas/compare/v0.2...dev
+[0.2]: https://github.com/sepandhaghighi/nafas/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/nafas/compare/c58087a...v0.1
 
 

MANIFEST.in

@@ -3,4 +3,5 @@ include *.md
 include *.spec
 include *.txt
 include *.yml
-include *.ini
+include *.ini
+include nafas/sounds/*.wav

NAFAS.spec

@@ -6,7 +6,7 @@ block_cipher = None
 a = Analysis(['nafas/__main__.py'],
              pathex=['nafas'],
              binaries=[],
-             datas=[],
+             datas=[('nafas/sounds/*.wav', 'nafas/sounds')],
              hiddenimports=[],
              hookspath=[],
              runtime_hooks=[],

README.md

@@ -30,6 +30,7 @@ Breathing gymnastics is a system of breathing exercises that focuses on the trea
 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.
 
 <table>
 	<tr> 
@@ -55,14 +56,9 @@ No need to walk away to take a break, just sit comfortably, run Nafas and let th
 		<td align="center">dev</td>	
 	</tr>
 	<tr>
-		<td align="center">Travis</td>
-		<td align="center"><a href="https://travis-ci.org/sepandhaghighi/nafas"><img src="https://travis-ci.org/sepandhaghighi/nafas.svg?branch=master"></a></td>
-		<td align="center"><a href="https://travis-ci.org/sepandhaghighi/nafas"><img src="https://travis-ci.org/sepandhaghighi/nafas.svg?branch=dev"></a></a></td>
-	</tr>
-	<tr>
-		<td align="center">AppVeyor</td>
-		<td align="center"><a href="https://ci.appveyor.com/project/sepandhaghighi/nafas"><img src="https://ci.appveyor.com/api/projects/status/3au823bgsaupgsup/branch/master?svg=true"></a></td>
-		<td align="center"><a href="https://ci.appveyor.com/project/sepandhaghighi/nafas"><img src="https://ci.appveyor.com/api/projects/status/3au823bgsaupgsup/branch/dev?svg=true"></a></td>
+		<td align="center">CI</td>
+		<td align="center"><img src="https://github.com/sepandhaghighi/nafas/workflows/CI/badge.svg?branch=master"></td>
+		<td align="center"><img src="https://github.com/sepandhaghighi/nafas/workflows/CI/badge.svg?branch=dev"></td>
 	</tr>
 </table>
 
@@ -80,19 +76,19 @@ No need to walk away to take a break, just sit comfortably, run Nafas and let th
 ## Installation		
 
 ### Source Code
-- Download [Version 0.1](https://github.com/sepandhaghighi/nafas/archive/v0.1.zip) or [Latest Source ](https://github.com/sepandhaghighi/nafas/archive/dev.zip)
+- Download [Version 0.2](https://github.com/sepandhaghighi/nafas/archive/v0.2.zip) or [Latest Source ](https://github.com/sepandhaghighi/nafas/archive/dev.zip)
 - `pip install -r requirements.txt` or `pip3 install -r requirements.txt` (Need root access)
 - `python3 setup.py install` or `python setup.py install` (Need root access)				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install nafas==0.1` or `pip3 install nafas==0.1` (Need root access)							
+- `pip install nafas==0.2` or `pip3 install nafas==0.2` (Need root access)							
 
 
 ### Exe Version (Only Windows)
-- Download [Exe-Version 0.1](https://github.com/sepandhaghighi/nafas/releases/download/v0.1/NAFAS-0.1.exe)
-- Run `NAFAS-0.1.exe`
+- Download [Exe-Version 0.2](https://github.com/sepandhaghighi/nafas/releases/download/v0.2/NAFAS-0.2.exe)
+- Run `NAFAS-0.2.exe`
 
 
 ## Usage			
@@ -141,7 +137,9 @@ or send an email to [[email protected]](mailto:[email protected] "[email protected]").
 
 <blockquote>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). </blockquote>				
 
-
+<blockquote>8- <a href="https://ttsmp3.com/">Free Text-To-Speech and Text-to-MP3 for US English</a> </blockquote>
+
+
 ## Donate to our project		
 							
 

dev-requirements.txt

@@ -1,4 +1,5 @@
-art==4.9
+art==5.1
+playsound==1.2.2
 codecov>=2.0.15
 pytest>=4.3.1
 pytest-cov>=2.6.1

nafas/__main__.py

@@ -2,7 +2,7 @@
 """nafas main."""
 
 import sys
-from nafas.functions import description_print, get_input_standard, input_filter, get_program_dict, run
+from nafas.functions import description_print, get_input_standard, input_filter, get_program_data, program_description_print, run
 from nafas.params import NAFAS_VERSION
 from art import tprint
 
@@ -14,5 +14,6 @@
     if len(args) < 2:
         input_data = get_input_standard()
         filtered_data = input_filter(input_data)
-        program_data = get_program_dict(filtered_data)
+        program_name, level, program_data = get_program_data(filtered_data)
+        program_description_print(program_name, level, program_data)
         run(program_data)