Implemented commands

Author: a-jean-andreasian

.gitignore

@@ -4,4 +4,8 @@ ff
 not_gitmodules.egg-info/
 setup.py
 *.pyc
-__pycache__/
+__pycache__/
+/notgitmodules.yaml
+/build/
+/my_gitmodules/
+/manual_test.py

README.md

@@ -4,7 +4,8 @@
 
 ## Why `not_gitmodules`?
 
-1. `not_gitmodules` demonstrate how simple and elegant `gitmodules` should be to those developers who enjoy their lives. Add and remove modules without caring about irrelevant stuff. No *
+1. `not_gitmodules` demonstrate how simple and elegant `gitmodules` should be to those developers who enjoy their lives.
+   Add and remove modules without caring about irrelevant stuff. No *
    *shitshow**, just simplicity.
 2. Production-use friendly. This is documented in the license.
 3. No third-party libraries are required; only built-in tools are used.
@@ -21,48 +22,76 @@
   pip install not-gitmodules
   ```
 
+---
+Here's the updated `README.md` snippet with the changes you requested:
+
 ---
 
 ## Usage
 
 1. **IMPORTANT:** Create a `notgitmodules.yaml` file in your project's root directory.
 
- ```yaml
- repos:
-   # directory: url (ssh or https)
-
-   # Example
-   file_reader: https://github.com/Free-Apps-for-All/file_manager_git_module
- ```
+```yaml
+repos:
+  # directory: url (ssh or https)
 
+  # Example
+  file_reader: https://github.com/Free-Apps-for-All/file_manager_git_module
+```
 
 2. Let `not_gitmodules` do the job.
 
-- **Example with Code**: 
+> ### Example with Code:
+>
+> Pass the path to the `initializer` function:
+> ```python
+> from not_gitmodules import initializer
+> 
+> initializer('custom/path/to/notgitmodules.yaml')
+> ```
+> or
+> ```python
+> from not_gitmodules import initializer
+> 
+> initializer()  # if notgitmodules.yaml exists in the project root
+> ```
+
+### Example with CLI:
+
+#### 1. Install the library locally if you cloned the repo (**optional**) :
+
+  ```bash
+  pip install .
+  ```
+
+---
 
-  Pass the path to the `initializer` function:
-   ```python
-   from not_gitmodules import initializer
+#### 2. Install the modules directly from the terminal:
 
-   initializer('/path/to/notgitmodules.yaml')
-   ```
+>#### Flags
+>
+>| Flag                | Description                                                             |
+>|---------------------|-------------------------------------------------------------------------|
+>| `-d`, `--dir_name`  | Specify a directory name where the modules will be saved (optional).    |
+>| `-y`, `--yaml-path` | Specify a custom location for the `notgitmodules.yaml` file (optional). |
 
-- **Example with CLI**:
+### Default command:
 
-   Install the library locally if you cloned the repo:
+```bash
+not_gitmodules install
+```
 
-   ```bash
-   pip install .
-   ```
+### Command pattern:
 
-   Once installed, you can delete the local repo from your system (the library is now saved in the virtual environment
-   or globally).
+```bash
+not_gitmodules install --yaml-path </path/to/notgitmodules.yaml>  --dir_name <directory_name>
+```
 
-   Run the `not_gitmodules` command directly from the terminal:
+or
 
-   ```bash
-   not_gitmodules
-   ```
+```bash
+not_gitmodules install -y </path/to/notgitmodules.yaml>  -d <directory_name>
+```
 
 ---
 

dev-requirements.txt

@@ -1,2 +1 @@
-pytest==7.2.0
 PyYAML~=6.0

not_gitmodules/cli.py

@@ -1,9 +1,24 @@
+import argparse
 from .core import initializer
 
 
 def cli():
-    yaml_path = input('Enter the custom path to notgitmodules.yaml, or press any button to skip if it is in the root.')
-    if not yaml_path.strip():
-        initializer(yaml_config_path='notgitmodules.yaml')
-    else:
-        initializer(yaml_path.strip())
+    arg_parser = argparse.ArgumentParser(description="GitHub repositories installation with not_gitmodules.")
+
+    arg_parser.add_argument(
+        "-y", "--yaml-path",
+        nargs="?",  # optional
+        default="notgitmodules.yaml",
+        help="Path to the custom YAML configuration file. By default it's notgitmodules.yaml."
+    )
+
+    arg_parser.add_argument(
+        "-d", "--dir_name",
+        nargs="?",  # optional
+        default="my_gitmodules",
+        help="The name of the directory the modules will be saved in. By default it's my_gitmodules."
+    )
+
+    args = arg_parser.parse_args()
+
+    initializer(yaml_config_path=args.yaml_path, root_dir_name=args.dir_name)

not_gitmodules/core.py

@@ -4,7 +4,7 @@
 
 def initializer(
     yaml_config_path: str = 'notgitmodules.yaml',
-    root_dir_name="no_gitmodules"
+    root_dir_name="my_gitmodules"
 ):
     """
     :param yaml_config_path: The path to notgitmodules.yaml file

setup.py

@@ -2,11 +2,12 @@
 
 setup(
     name='not_gitmodules',
-    version='0.1.3.1',
+    version='0.1.3.2',
     packages=find_packages(),
     license='Custom License',
     entry_points={
         'console_scripts': [
+            'not_gitmodules install=not_gitmodules.cli:cli',
             'not_gitmodules=not_gitmodules.cli:cli',
         ],
     },