Disambiguation project/package name. Added github_username to templating

appliedAI-Initiative · Apr 29, 2024 · a34b296 · a34b296
1 parent b7eef62
commit a34b296
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ The template includes CI/CD pipelines based on github actions. The documentation
 
 In the documentation links to source code will be created, therefore you will be prompted to give the project's url.
 
-See the resulting repository's [contributing guidelines]({{cookiecutter.project_name}}/docs/04_contributing/04_contributing.rst) 
+See the resulting repository's [contributing guidelines](docs/04_contributing/04_contributing.rst) 
 for further details. Some examples for projects following the general style of the template are [tianshou](https://github.com/thu-ml/tianshou)
 and [armscan_env](https://github.com/appliedAI-Initiative/armscan_env/)
 

diff --git a/cookiecutter.json b/cookiecutter.json
@@ -2,6 +2,7 @@
   "project_name": "",
   "author": "",
   "author_email": "",
+  "github_username": "{{cookiecutter.author}}",
   "package_name": "{{cookiecutter.project_name}}",
   "python_version": ["3.11", "3.12"],
   "project_url": "https://github.com/{{cookiecutter.author}}/{{cookiecutter.project_name}}",

diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py
@@ -2,12 +2,12 @@
 
 MODULE_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]+$"
 
-project_name = "{{cookiecutter.project_name}}"
+package_name = "{{cookiecutter.package_name}}"
 project_url = "{{cookiecutter.project_url}}"
 
-if not re.match(MODULE_REGEX, project_name):
+if not re.match(MODULE_REGEX, package_name):
     raise Exception(
-        f"The project name {project_name} is not a valid Python module name"
+        f"The project name {package_name} is not a valid Python module name"
     )
 
 if not project_url.startswith("http"):

diff --git a/{{cookiecutter.project_name}}/docs/02_notebooks/01_library_example.ipynb b/{{cookiecutter.project_name}}/docs/02_notebooks/01_library_example.ipynb
@@ -38,7 +38,7 @@
    "outputs": [],
    "source": [
     "# Here an illustration of your library\n",
-    "from {{cookiecutter.project_name}}.sample_package.sample_module import hello_stranger\n",
+    "from {{cookiecutter.package_name}}.sample_package.sample_module import hello_stranger\n",
     "\n",
     "hello_stranger()"
    ]

diff --git a/{{cookiecutter.project_name}}/docs/04_contributing/04_contributing.rst b/{{cookiecutter.project_name}}/docs/04_contributing/04_contributing.rst
@@ -77,7 +77,7 @@ Documentation Generation Test
 
 We have the following three documentation tests:
 
-1. pydocstyle (as part of ruff): test all docstring under ``{{cookiecutter.project_name}}/``;
+1. pydocstyle (as part of ruff): test all docstrings;
 
 2. doc8 (as part of ruff): test ReStructuredText format;
 

diff --git a/{{cookiecutter.project_name}}/docs/_config.yml b/{{cookiecutter.project_name}}/docs/_config.yml
@@ -105,8 +105,8 @@ sphinx:
     suppress_warnings: ["mystnb.unknown_mime_type"]  # needed for plotly rendering
     autodoc_show_sourcelink: True
     add_module_names: False
-    github_username: {{cookiecutter.author}}
-    github_repository: {{cookiecutter.project_name}}
+    github_username: {{cookiecutter.github_username}}
+    github_repository: {{cookiecutter.project_url}}
     python_use_unqualified_type_names: True
     nb_mime_priority_overrides: [
       [ 'html', 'application/vnd.jupyter.widget-view+json', 10 ],

diff --git a/{{cookiecutter.project_name}}/pyproject.toml b/{{cookiecutter.project_name}}/pyproject.toml
@@ -120,7 +120,7 @@ max-complexity = 20
 "docs/**" = ["D103"]
 "examples/**" = ["D103"]
 
-[tool.poetry_bumpversion.file."{{cookiecutter.project_name}}/__init__.py"]
+[tool.poetry_bumpversion.file."{{cookiecutter.package_name}}/__init__.py"]
 
 [tool.poetry-sort]
 move-optionals-to-bottom = true

diff --git a/{{cookiecutter.project_name}}/scripts/run_sample.py b/{{cookiecutter.project_name}}/scripts/run_sample.py
@@ -1,4 +1,4 @@
-from {{cookiecutter.project_name}}.sample_module import SampleClass
+from {{cookiecutter.package_name}}.sample_module import SampleClass
 
 if __name__ == "__main__":
     print(SampleClass().sample_method("{{cookiecutter.author}}"))

diff --git a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_module.py b/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/sample_module.py
@@ -13,7 +13,7 @@ def __init__(self, param: str | None = None):
         self.param = param
 
     def sample_method(self, name: str) -> str:
-        """>>> from {{cookiecutter.project_name}}.sample_module import SampleClass
+        """>>> from {{cookiecutter.package_name}}.sample_module import SampleClass
         >>>
         >>> greeter = SampleClass()
         >>> greeter.sample_method("{{cookiecutter.author}}")

diff --git a/{{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/test_sample_class.py b/{{cookiecutter.project_name}}/test/{{cookiecutter.project_name}}/test_sample_class.py
@@ -1,4 +1,4 @@
-from {{cookiecutter.project_name}}.sample_module import SampleClass
+from {{cookiecutter.package_name}}.sample_module import SampleClass
 
 
 # the suggested naming convention for unit tests is test_method_name_testDescriptionInCamelCase