Feature/cli (#47)

* add --file argument to arg parser

* nava handling of --file argument

* `CHANGELOG.md` updated

* `autopep8.sh` applied

* add SOUND_FILE_NAME_EXIST_ERROR string

* handle non-named arg

* fulfill the implementation of `nava --file="test.wav"`, `nava "test.wav"` and `nava test.wav`

* remove trailing whitespaces

* update : `__main__.py` updated.

* add : `play_cli` function added.

* add : version test added.

* update : `README.md` updated.

* remove : `SOUND_FILE_NAME_EXIST_ERROR` removed.

* fix : typo in README.md fixed.

* fix : changelog fixed.

* update : readme updated.

* apply : requested changes applied.

* fix mentinoed issue by Sepand

* add `-v` flag

* apply `autopep8.sh`

---------

Co-authored-by: Sadra Sabouri <[email protected]>

.github/workflows/linux_test.yml

@@ -29,6 +29,7 @@ jobs:
     - name: First test
       run: |
         sudo nava
+        sudo nava --version
     - name: Install ALSA
       run: |
         sudo apt-get update

.github/workflows/macOS_test.yml

@@ -29,6 +29,7 @@ jobs:
     - name: First test
       run: |
         nava
+        nava --version
     - name: Test requirements Installation
       run: |
         python others/requirements-splitter.py

.github/workflows/windows_test.yml

@@ -29,6 +29,7 @@ jobs:
     - name: First test
       run: |
         nava
+        nava --version
     - name: Install Scream
       shell: powershell
       run: |

CHANGELOG.md

@@ -6,8 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 ### Added
+- `play_cli` function
 - `SECURITY.md`
 ### Changed
+- `main` function updated
 - OSs local checklist added to pull request template
 - `README.md` modified
 ## [0.5] - 2024-04-03

README.md

@@ -130,6 +130,11 @@ except NavaBaseError as e:
     print(str(e))
 ```
 
+### CLI
+```bash
+$ nava [--file FILE_PATH] [--loop] FILE_PATH
+```
+
 ## Engine
 
 List of different platforms and the corresponding engines that are used for sound playing.

nava/__main__.py

@@ -1,10 +1,9 @@
 # -*- coding: utf-8 -*-
 """Nava main."""
-
-import sys
+import argparse
 from art import tprint
 from .params import NAVA_VERSION
-from .functions import nava_help
+from .functions import nava_help, play_cli
 
 
 def main():
@@ -13,10 +12,38 @@ def main():
 
     :return: None
     """
-    args = sys.argv
-    tprint("nava")
-    tprint("V:" + NAVA_VERSION)
-    nava_help()
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        'filename',
+        nargs='?',
+        type=str,
+        metavar='FILE_PATH',
+        help='path to audio file'
+    )
+    parser.add_argument(
+        '--file',
+        nargs='?',
+        type=str,
+        metavar='FILE_PATH',
+        help='path to audio file',
+    )
+    parser.add_argument('--loop', help='sound play in loop', action='store_true', default=False)
+    parser.add_argument('--version', help="version", action='store_true', default=False)
+    parser.add_argument('-v', help="version", action='store_true', default=False)
+    args = parser.parse_known_args()[0]
+    if args.version or args.v:
+        print(NAVA_VERSION)
+    elif args.filename or args.file:
+        file_name = args.filename
+        if args.file:
+            file_name = args.file
+        loop = args.loop
+        play_cli(file_name, loop=loop)
+    else:
+        tprint("Nava")
+        tprint("V:" + NAVA_VERSION)
+        nava_help()
+        parser.print_help()
 
 
 if __name__ == "__main__":

nava/functions.py

@@ -55,7 +55,7 @@ def nava_help():
     """
     print(OVERVIEW)
     print("Repo : https://github.com/openscilab/nava")
-    print("Webpage : https://openscilab.com/")
+    print("Webpage : https://openscilab.com/\n")
 
 
 def quote(func):
@@ -275,3 +275,23 @@ def play(sound_path, async_mode=False, loop=False):
             return __play_linux(sound_path, async_mode, loop)
     except Exception:  # pragma: no cover
         raise NavaBaseError(SOUND_FILE_PLAY_ERROR)
+
+
+def play_cli(sound_path, loop=False):
+    """
+    Play sound from CLI.
+
+    :param sound_path: sound path
+    :type sound_path: str
+    :param loop: sound loop flag
+    :type loop: bool
+    :return: None
+    """
+    try:
+        while True:
+            play(sound_path)
+            if not loop:
+                break
+    except KeyboardInterrupt:
+        stop_all()
+        sys.exit(0)