From 7bab34b3c2e80afdfb8a30c319e29e5394f642d9 Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Wed, 6 Mar 2024 10:27:51 +0100 Subject: [PATCH 01/10] fix issue #7 by adding docstrings to some of the standard files of the template --- ....dependency_manager != 'pip' else 'freeze_dependencies.py'}} | 2 ++ {{cookiecutter.project_name}}/tests/__init__.py | 1 + 2 files changed, 3 insertions(+) diff --git a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} index 8cde356..4bbb989 100644 --- a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} +++ b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} @@ -10,6 +10,7 @@ class TomlSplitListsEncoder(toml.TomlEncoder): """Custom encoder to split lists into multiple lines.""" def dump_list(self, v) -> str: + """Docstring to shut up ruff.""" if len(v) == 0: return "[]" else: @@ -20,6 +21,7 @@ class TomlSplitListsEncoder(toml.TomlEncoder): return retval def dump_value(self, v) -> str: + """Docstring to shut up ruff.""" dump = super().dump_value(v) if isinstance(v, str) and "\\n" in dump: dump = dump.replace("\\n", "\n") diff --git a/{{cookiecutter.project_name}}/tests/__init__.py b/{{cookiecutter.project_name}}/tests/__init__.py index e69de29..b1c7c02 100644 --- a/{{cookiecutter.project_name}}/tests/__init__.py +++ b/{{cookiecutter.project_name}}/tests/__init__.py @@ -0,0 +1 @@ +"""Shutting up pylint comlaining about D104.""" From e53854631582ed646c55a88cd5846da76ecfb59b Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Wed, 6 Mar 2024 10:36:26 +0100 Subject: [PATCH 02/10] making the pre-commit config hidden, so it is seen upon project install --- .../{pre-commit-config.yaml => .pre-commit-config.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {{cookiecutter.project_name}}/{pre-commit-config.yaml => .pre-commit-config.yaml} (100%) diff --git a/{{cookiecutter.project_name}}/pre-commit-config.yaml b/{{cookiecutter.project_name}}/.pre-commit-config.yaml similarity index 100% rename from {{cookiecutter.project_name}}/pre-commit-config.yaml rename to {{cookiecutter.project_name}}/.pre-commit-config.yaml From 5dad34c55c6bf179abcc4c424f30a6f7a6927e1f Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Wed, 6 Mar 2024 10:44:19 +0100 Subject: [PATCH 03/10] more docstring fixes --- {{cookiecutter.project_name}}/tests/test_dummy.py | 1 + 1 file changed, 1 insertion(+) diff --git a/{{cookiecutter.project_name}}/tests/test_dummy.py b/{{cookiecutter.project_name}}/tests/test_dummy.py index 8d5f614..731e987 100644 --- a/{{cookiecutter.project_name}}/tests/test_dummy.py +++ b/{{cookiecutter.project_name}}/tests/test_dummy.py @@ -2,4 +2,5 @@ def test_dummy() -> None: + """Dummy Test module.""" assert True From 3ab63f40f300a7b30bc33413d0f55cfcd2f92ce5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Bourbeau?= <27770178+bourdeet@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:21:55 +0100 Subject: [PATCH 04/10] Update {{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} Co-authored-by: Dan Saattrup Nielsen <47701536+saattrupdan@users.noreply.github.com> --- ..._manager != 'pip' else 'freeze_dependencies.py'}} | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} index 4bbb989..52bfedc 100644 --- a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} +++ b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} @@ -21,7 +21,17 @@ class TomlSplitListsEncoder(toml.TomlEncoder): return retval def dump_value(self, v) -> str: - """Docstring to shut up ruff.""" + """Convert an object to a string representation. + + In case the object is a string then we ensure that newlines are preserved. + + Args: + v: + The object to be dumped. + + Returns: + A string representation of the object. + """" dump = super().dump_value(v) if isinstance(v, str) and "\\n" in dump: dump = dump.replace("\\n", "\n") From 3b25729e43051816ce88eb35c764fa6ab0d374c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Bourbeau?= <27770178+bourdeet@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:22:09 +0100 Subject: [PATCH 05/10] Update {{cookiecutter.project_name}}/tests/__init__.py Co-authored-by: Dan Saattrup Nielsen <47701536+saattrupdan@users.noreply.github.com> --- {{cookiecutter.project_name}}/tests/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/tests/__init__.py b/{{cookiecutter.project_name}}/tests/__init__.py index b1c7c02..3576137 100644 --- a/{{cookiecutter.project_name}}/tests/__init__.py +++ b/{{cookiecutter.project_name}}/tests/__init__.py @@ -1 +1 @@ -"""Shutting up pylint comlaining about D104.""" +"""Unit tests for the project.""" From 0352949666afd88753206a2d334fd4d77144b763 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Bourbeau?= <27770178+bourdeet@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:22:18 +0100 Subject: [PATCH 06/10] Update {{cookiecutter.project_name}}/tests/test_dummy.py Co-authored-by: Dan Saattrup Nielsen <47701536+saattrupdan@users.noreply.github.com> --- {{cookiecutter.project_name}}/tests/test_dummy.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/tests/test_dummy.py b/{{cookiecutter.project_name}}/tests/test_dummy.py index 731e987..3d2b8ff 100644 --- a/{{cookiecutter.project_name}}/tests/test_dummy.py +++ b/{{cookiecutter.project_name}}/tests/test_dummy.py @@ -2,5 +2,5 @@ def test_dummy() -> None: - """Dummy Test module.""" + """Dummy test function.""" assert True From 4ddd85463d7433955991763f504e3869213b355a Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Tue, 12 Mar 2024 12:48:41 +0100 Subject: [PATCH 07/10] typo fix --- ....dependency_manager != 'pip' else 'freeze_dependencies.py'}} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} index 52bfedc..e937845 100644 --- a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} +++ b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} @@ -31,7 +31,7 @@ class TomlSplitListsEncoder(toml.TomlEncoder): Returns: A string representation of the object. - """" + """ dump = super().dump_value(v) if isinstance(v, str) and "\\n" in dump: dump = dump.replace("\\n", "\n") From 41132cccfe007ab5a13cf9ef89fe4158734e5fd7 Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Tue, 12 Mar 2024 12:53:15 +0100 Subject: [PATCH 08/10] added docstring + fixed typos in template files --- {{cookiecutter.project_name}}/config/__init__.py | 1 + ...endency_manager != 'pip' else 'freeze_dependencies.py'}} | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.project_name}}/config/__init__.py b/{{cookiecutter.project_name}}/config/__init__.py index e69de29..206fafb 100644 --- a/{{cookiecutter.project_name}}/config/__init__.py +++ b/{{cookiecutter.project_name}}/config/__init__.py @@ -0,0 +1 @@ +"""Config files to be used with hydra.""" diff --git a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} index e937845..ebe3a83 100644 --- a/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} +++ b/{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}} @@ -22,13 +22,13 @@ class TomlSplitListsEncoder(toml.TomlEncoder): def dump_value(self, v) -> str: """Convert an object to a string representation. - + In case the object is a string then we ensure that newlines are preserved. - + Args: v: The object to be dumped. - + Returns: A string representation of the object. """ From fa76b5e3149686a75370e6e00ae9217f3c616cc1 Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Tue, 12 Mar 2024 12:57:18 +0100 Subject: [PATCH 09/10] removing a file that gets created during install --- {{cookiecutter.project_name}}/tests/__init__.py | 1 - 1 file changed, 1 deletion(-) delete mode 100644 {{cookiecutter.project_name}}/tests/__init__.py diff --git a/{{cookiecutter.project_name}}/tests/__init__.py b/{{cookiecutter.project_name}}/tests/__init__.py deleted file mode 100644 index 3576137..0000000 --- a/{{cookiecutter.project_name}}/tests/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Unit tests for the project.""" From 0e0406471e9133d398c628456d241f4303a0edaf Mon Sep 17 00:00:00 2001 From: bourdeet <27770178+bourdeet@users.noreply.github.com> Date: Tue, 12 Mar 2024 12:59:38 +0100 Subject: [PATCH 10/10] removing a file that gets created during install --- .../src/{{cookiecutter.project_name}}/__init__.py | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 {{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py diff --git a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py b/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py deleted file mode 100644 index b96b390..0000000 --- a/{{cookiecutter.project_name}}/src/{{cookiecutter.project_name}}/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -""" -.. include:: ../../README.md -""" - -import importlib.metadata - -# Fetches the version of the package as defined in pyproject.toml -__version__ = importlib.metadata.version(__package__)