Cite (#118)

* doc : cite section added to README.md

* fix : description_print function updated

* fix : tests updated

* fix : description_print function updated

* fix : minor import bug fixed

* fix : tests updated

README.md

@@ -153,6 +153,23 @@ You can also join our discord server
 
 <blockquote>13- <a href="https://www.yogabasics.com/practice/pranayama/">Pranayama Breathing Techniques and Tips</a> </blockquote>
 
+## Cite
+
+If you use Nafas in your research, we would appreciate citations to the following paper:
+
+<pre>
+Sabouri, Sadra, and Sepand Haghighi. "Nafas: Breathing Gymnastics Application." arXiv preprint arXiv:2412.04667 (2024).
+</pre>
+<pre>
+
+@article{sabouri2024nafas,
+  title={Nafas: Breathing Gymnastics Application},
+  author={Sabouri, Sadra and Haghighi, Sepand},
+  journal={arXiv preprint arXiv:2412.04667},
+  year={2024}
+}
+
+</pre>
 
 ## Show Your Support
 								

nafas/functions.py

@@ -2,7 +2,8 @@
 """nafas functions."""
 
 import time
-from nafas.params import NAFAS_DESCRIPTION, NAFAS_TIPS, NAFAS_CAUTIONS, STANDARD_MENU, STANDARD_MENU_ORDER, STEP_MAP
+from nafas.params import NAFAS_LINKS, NAFAS_DESCRIPTION, NAFAS_TIPS, NAFAS_CAUTIONS
+from nafas.params import STANDARD_MENU, STANDARD_MENU_ORDER, STEP_MAP
 from nafas.params import PROGRAMS, PROGRAM_DESCRIPTION, SOUND_MAP, STEP_TEMPLATE, CYCLE_TEMPLATE
 from nafas.params import SOUND_WARNING_MESSAGE, EXIT_MESSAGE, BAD_INPUT_MESSAGE, PROGRAM_END_MESSAGE
 from nafas.params import MINUTES_TEMPLATE, SECONDS_TEMPLATE, PROGRAM_TIME_TEMPLATE
@@ -147,7 +148,10 @@ def description_print():
 
     :return: None
     """
+    print(NAFAS_LINKS)
+    line()
     print("\n".join(justify(NAFAS_DESCRIPTION.split(), 100)))
+    line()
     print(NAFAS_TIPS)
     line()
     print(NAFAS_CAUTIONS)

nafas/params.py

@@ -10,6 +10,12 @@
 No need to walk away to take a break, just sit comfortably, run Nafas and let the journey begin.
 """
 
+NAFAS_LINKS = """
+Repository: https://github.com/sepandhaghighi/nafas
+Paper: https://arxiv.org/abs/2412.04667
+* If you use Nafas in your research, please cite our paper
+"""
+
 NAFAS_TIPS = """
 Breathing tips:
 

test/test.py

@@ -11,12 +11,19 @@
 >>> line(10,"*")
 **********
 >>> description_print()
+<BLANKLINE>
+Repository: https://github.com/sepandhaghighi/nafas
+Paper: https://arxiv.org/abs/2412.04667
+* If you use Nafas in your research, please cite our paper
+<BLANKLINE>
+######################################################################
 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.
+######################################################################
 <BLANKLINE>
 Breathing tips:
 <BLANKLINE>