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 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 8cde356..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'}} @@ -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,17 @@ class TomlSplitListsEncoder(toml.TomlEncoder): return retval 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. + """ dump = super().dump_value(v) if isinstance(v, str) and "\\n" in dump: dump = dump.replace("\\n", "\n") 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__) diff --git a/{{cookiecutter.project_name}}/tests/__init__.py b/{{cookiecutter.project_name}}/tests/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/{{cookiecutter.project_name}}/tests/test_dummy.py b/{{cookiecutter.project_name}}/tests/test_dummy.py index 8d5f614..3d2b8ff 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 function.""" assert True