Skip to content

Commit 6e85780

Browse files
Updated README.md
1 parent 36c452b commit 6e85780

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ __pycache__/
1313
/config.yaml
1414
/dev/my_gitmodules/
1515
/dev/my_libs/
16+
venv/
17+

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# <img src=".github/logo_v2.png" alt="Not Gitmodules!" height="30" /> Not Gitmodules
1+
# <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
22

33
---
44

@@ -58,7 +58,7 @@ Choose the most convenient way to install Not Gitmodules:
5858

5959
2. **Install via a package manager** and use **as a Python package** _(example with pip)_:
6060

61-
![PyPI](https://img.shields.io/pypi/v/not-gitmodules)
61+
![PyPI](https://img.shields.io/pypi/v/not-gitmodules)
6262
```bash
6363
pip install not-gitmodules
6464
```
@@ -181,22 +181,22 @@ CMD ["python", "main.py"]
181181
182182
1. Not Gitmodules **doesn't require to keep the folders** with modules. You can safely .gitignore or delete them.
183183
2. **Do not use matching names** for the repositories in `notgitmodules.yaml` file. In that case only the first repository
184-
will be downloaded and the second one will be skipped.
184+
will be downloaded and the second one will be skipped.
185185
3. Not Gitmodules **needs** `Git` and `PyYAML` for functioning.
186186
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)_.
187187
5. Not Gitmodules **doesn't download the sub-dependency submodules** (if they are not defined properly for Git).
188-
- Reason: it's practically inefficient, may lead to bugs and bottlenecks, and better to maintain manually.
189-
- Solution: Include the sub-dependency submodule to YAML file manually.
188+
- Reason: it's practically inefficient, may lead to bugs and bottlenecks, and better to maintain manually.
189+
- Solution: Include the sub-dependency submodule to YAML file manually.
190190
6. Not Gitmodules keeps the view of keeping the project structure clean. All submodules among one
191191
project/microservice need to go to one folder. It's recommended to use dependency injection in case of having nested `not_gitmodules`.
192-
7. **Possible bottleneck** with private repositories.
192+
7. **Possible bottleneck** with private repositories.
193193
- If cloning fails, but you have access to the repository, provide the HTTPS repo URL instead of SSH url in YAML file.
194194

195195

196196
---
197197

198198
<div style="text-align: center;">
199-
<img src=".github/pic1.png" width="300" height="300">
199+
<img src="https://raw.githubusercontent.com/a-jean-andreasian/not_gitmodules/refs/heads/master/.github/pic1.png" width="300" height="300">
200200
</div>
201201

202202
---
@@ -218,6 +218,6 @@ Armen-Jean Andreasian, 2024
218218
---
219219

220220
<div style="text-align: center;">
221-
<img src=".github/pic2.png" />
221+
<img src="https://raw.githubusercontent.com/a-jean-andreasian/not_gitmodules/refs/heads/master/.github/pic2.png" />
222222
</div>
223223

test_initializer.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
from not_gitmodules import initializer
55
from not_gitmodules.cli import cli
66

7+
module_for_test = "https://github.com/not-gitmodules/notgitmodules-file-manager-py"
8+
79

810
class TestInitializerFunction(unittest.TestCase):
911
@patch(
1012
"builtins.open",
1113
new_callable=mock_open,
12-
read_data="file_manager: https://github.com/Armen-Jean-Andreasian/FileManager-Git-Module",
14+
read_data=f"file_manager: {module_for_test}",
1315
)
1416
@patch("not_gitmodules.core.read_yaml")
1517
def test_initializer_with_valid_yaml(self, mock_read_yaml, mock_file):
1618
mock_read_yaml.return_value = {
17-
"file_manager": "https://github.com/Armen-Jean-Andreasian/FileManager-Git-Module"
19+
"file_manager": f"{module_for_test}",
1820
}
1921

2022
initializer("notgitmodules.yaml")
@@ -43,7 +45,7 @@ def test_initializer_with_invalid_yaml(self, mock_subprocess, mock_print, mock_r
4345
@patch(
4446
"builtins.open",
4547
new_callable=mock_open,
46-
read_data="file_manager: https://github.com/Armen-Jean-Andreasian/FileManager-Git-Module",
48+
read_data=f"file_manager: {module_for_test}",
4749
)
4850
@patch("not_gitmodules.core.read_yaml")
4951
def test_cli_with_default_input(self, mock_read_yaml, mock_file):

0 commit comments

Comments
 (0)