Update readme (#19)

* Updated README.md

* Updated README.md

* Fixed Github CI, set  to 3.12

* Fixed Github CI, set  to 3.12 and PyYAML to 6.0.2

* Fixed test_initializer.py

Author: a-jean-andreasian

.github/workflows/python-ci.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: '3.12'
 
       - name: Install dependencies (production)
         run: |

.gitignore

@@ -13,3 +13,5 @@ __pycache__/
 /config.yaml
 /dev/my_gitmodules/
 /dev/my_libs/
+venv/
+

README.md

@@ -1,4 +1,4 @@
-# <img src=".github/logo_v2.png" alt="Not Gitmodules!" height="30" /> Not Gitmodules
+# <img src="https://raw.githubusercontent.com/a-jean-andreasian/not_gitmodules/refs/heads/master/.github/logo_v2.png" alt="Not Gitmodules!" height="30" /> Not Gitmodules
 
 ---
 
@@ -58,7 +58,7 @@ Choose the most convenient way to install Not Gitmodules:
 
 2. **Install via a package manager** and use **as a Python package** _(example with pip)_:
 
-    ![PyPI](https://img.shields.io/pypi/v/not-gitmodules)
+   ![PyPI](https://img.shields.io/pypi/v/not-gitmodules)
     ```bash  
     pip install not-gitmodules
     ```  
@@ -181,22 +181,22 @@ CMD ["python", "main.py"]
 
 1. Not Gitmodules **doesn't require to keep the folders** with modules. You can safely .gitignore or delete them.
 2. **Do not use matching names** for the repositories in `notgitmodules.yaml` file. In that case only the first repository
-  will be downloaded and the second one will be skipped.
+   will be downloaded and the second one will be skipped.
 3. Not Gitmodules **needs** `Git` and `PyYAML` for functioning.
 4. Not Gitmodules, just like Gitmodules, **doesn't automatically install the dependencies of submodules** _(such as requirements.txt for Python or package.json for JavaScript)_.
 5. Not Gitmodules **doesn't download the sub-dependency submodules** (if they are not defined properly for Git).
-   - Reason: it's practically inefficient, may lead to bugs and bottlenecks, and better to maintain manually.
-   - Solution: Include the sub-dependency submodule to YAML file manually.
+    - Reason: it's practically inefficient, may lead to bugs and bottlenecks, and better to maintain manually.
+    - Solution: Include the sub-dependency submodule to YAML file manually.
 6. Not Gitmodules keeps the view of keeping the project structure clean. All submodules among one
    project/microservice need to go to one folder. It's recommended to use dependency injection in case of having nested `not_gitmodules`.
-7. **Possible bottleneck** with private repositories. 
+7. **Possible bottleneck** with private repositories.
     -  If cloning fails, but you have access to the repository, provide the HTTPS repo URL instead of SSH url in YAML file.
-
+8. If your python version is incompatible with `PyYAML==6.0` try to install the compatible version of `PyYAML`.  
 
 ---
 
 <div style="text-align: center;">
-  <img src=".github/pic1.png" width="300" height="300">
+  <img src="https://raw.githubusercontent.com/a-jean-andreasian/not_gitmodules/refs/heads/master/.github/pic1.png" width="300" height="300">
 </div>
 
 ---
@@ -218,6 +218,6 @@ Armen-Jean Andreasian, 2024
 ---
 
 <div style="text-align: center;">
-  <img src=".github/pic2.png" />
+  <img src="https://raw.githubusercontent.com/a-jean-andreasian/not_gitmodules/refs/heads/master/.github/pic2.png" />
 </div>
 

requirements.txt

@@ -1 +1 @@
-PyYAML~=6.0
+PyYAML==6.0.2

test_initializer.py

@@ -4,17 +4,21 @@
 from not_gitmodules import initializer
 from not_gitmodules.cli import cli
 
+module_for_test = "https://github.com/not-gitmodules/notgitmodules-file-manager-py"
+
 
 class TestInitializerFunction(unittest.TestCase):
     @patch(
         "builtins.open",
         new_callable=mock_open,
-        read_data="file_manager: https://github.com/Armen-Jean-Andreasian/FileManager-Git-Module",
+        read_data=f"file_manager: {module_for_test}",
     )
     @patch("not_gitmodules.core.read_yaml")
     def test_initializer_with_valid_yaml(self, mock_read_yaml, mock_file):
         mock_read_yaml.return_value = {
-            "file_manager": "https://github.com/Armen-Jean-Andreasian/FileManager-Git-Module"
+            "file_manager": {
+                "main": module_for_test
+            }
         }
 
         initializer("notgitmodules.yaml")
@@ -25,7 +29,11 @@ def test_initializer_with_valid_yaml(self, mock_read_yaml, mock_file):
     @patch("builtins.print")
     @patch("subprocess.run")
     def test_initializer_with_invalid_yaml(self, mock_subprocess, mock_print, mock_read_yaml, mock_file):
-        mock_read_yaml.return_value = {"file_manager": "invalid_repo"}
+        mock_read_yaml.return_value = {
+            "file_manager": {
+                "broken": "invalid_repo"
+            }
+        }
 
         mock_subprocess.side_effect = subprocess.CalledProcessError(
             returncode=1, cmd="git clone", stderr="error"
@@ -34,16 +42,17 @@ def test_initializer_with_invalid_yaml(self, mock_subprocess, mock_print, mock_r
         initializer("notgitmodules.yaml")
 
         expected_calls = [
-            call("Directory 'my_gitmodules/file_manager' already exists. Skipping..."),
+            call("Directory 'my_gitmodules/file_manager/broken' already exists. Skipping..."),
             call("Failed to clone invalid_repo: error"),
         ]
 
         self.assertTrue(any(call in mock_print.mock_calls for call in expected_calls))
 
+
     @patch(
         "builtins.open",
         new_callable=mock_open,
-        read_data="file_manager: https://github.com/Armen-Jean-Andreasian/FileManager-Git-Module",
+        read_data=f"file_manager: {module_for_test}",
     )
     @patch("not_gitmodules.core.read_yaml")
     def test_cli_with_default_input(self, mock_read_yaml, mock_file):