Added python project content (#3)

Author: davidbrownell

.github/workflows/standard.yaml

@@ -1,6 +1,8 @@
 # ----------------------------------------------------------------------
-# SPDX-FileCopyrightText: 2024 Scientific Software Engineering Center <ssec-dev@gatech.edu>
-# SPDX-License-Identifier: MIT
+#
+# Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# Distributed under the MIT License.
+#
 # ----------------------------------------------------------------------
 name: "Standard"
 

BootstrapEpilog.py

@@ -1,6 +1,8 @@
 # ----------------------------------------------------------------------
-# SPDX-FileCopyrightText: 2024 Scientific Software Engineering Center <ssec-dev@gatech.edu>
-# SPDX-License-Identifier: MIT
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
 # ----------------------------------------------------------------------
 # pylint: disable=missing-module-docstring
 

Build.py

@@ -1,6 +1,8 @@
 # ----------------------------------------------------------------------
-# SPDX-FileCopyrightText: 2024 Scientific Software Engineering Center <ssec-dev@gatech.edu>
-# SPDX-License-Identifier: MIT
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
 # ----------------------------------------------------------------------
 """Build tasks for this python module."""
 
@@ -37,28 +39,33 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
 # ----------------------------------------------------------------------
 this_dir = PathEx.EnsureDir(Path(__file__).parent)
 src_dir = PathEx.EnsureDir(this_dir / "src")
+package_dir = PathEx.EnsureDir(src_dir / "PythonProjectBootstrapper")
 tests_dir = PathEx.EnsureDir(this_dir / "tests")
 
 
 # ----------------------------------------------------------------------
-Black = RepoBuildTools.BlackFuncFactory(this_dir, app)
+Black = RepoBuildTools.BlackFuncFactory(
+    this_dir,
+    app,
+    '--force-exclude "{{ cookiecutter.__empty_dir }}"',
+)
 
 Pylint = RepoBuildTools.PylintFuncFactory(
-    src_dir / "PythonProjectBootstrapper",
+    package_dir,
     app,
     default_min_score=9.5,
 )
 
 Pytest = RepoBuildTools.PytestFuncFactory(
     tests_dir,
-    "PythonProjectBootstrapper",
+    package_dir.name,
     app,
     default_min_coverage=70.0,
 )
 
 UpdateVersion = RepoBuildTools.UpdateVersionFuncFactory(
     src_dir,
-    PathEx.EnsureFile(src_dir / "PythonProjectBootstrapper" / "__init__.py"),
+    PathEx.EnsureFile(package_dir / "__init__.py"),
     app,
 )
 
@@ -71,6 +78,8 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
     app,
 )
 
+CreateDockerImage = RepoBuildTools.CreateDockerImageFuncFactory(this_dir, app)
+
 
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------

src/BuildBinary.py

@@ -1,11 +1,14 @@
 # ----------------------------------------------------------------------
-# SPDX-FileCopyrightText: 2024 Scientific Software Engineering Center <ssec-dev@gatech.edu>
-# SPDX-License-Identifier: MIT
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
 # ----------------------------------------------------------------------
 """Builds the binary for this project."""
 
 import datetime
 import importlib
+import os
 import textwrap
 
 from pathlib import Path, PurePath
@@ -75,12 +78,25 @@
 # ----------------------------------------------------------------------
 _include_files: list[tuple[str, str]] = []
 
-for child in PathEx.EnsureDir(
-    _this_dir / "PythonProjectBootstrapper" / "python_project" / "hooks"
-).iterdir():
-    relative_path = PurePath(*child.parts[len(_this_dir.parts) :])
+_project_root = PathEx.EnsureDir(_this_dir / "PythonProjectBootstrapper" / "python_project")
+_lib_path = PurePath("lib")
 
-    _include_files.append((relative_path.as_posix(), (PurePath("lib") / relative_path).as_posix()))
+for root, _, filenames in os.walk(_project_root):
+    if not filenames:
+        continue
+
+    root_path = Path(root)
+    relative_path = PurePath(*root_path.parts[len(_this_dir.parts) :])
+
+    for filename in filenames:
+        fullpath = root_path / filename
+
+        _include_files.append(
+            (
+                (relative_path / filename).as_posix(),
+                (_lib_path / relative_path / filename).as_posix(),
+            )
+        )
 
 
 # ----------------------------------------------------------------------

src/PythonProjectBootstrapper/EntryPoint.py

@@ -1,6 +1,6 @@
 # ----------------------------------------------------------------------
 # |
-# |  Copyright Scientific Software Engineering Center at Georgia Tech 2024
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
 # |  Distributed under the MIT License.
 # |
 # ----------------------------------------------------------------------
@@ -19,6 +19,11 @@
 from dbrownell_Common import PathEx
 from PythonProjectBootstrapper import __version__
 
+# The following imports are used in cookiecutter hooks. Import them here to
+# ensure that they are frozen when creating binaries,
+import shutil  # pylint: disable=unused-import, wrong-import-order
+import textwrap  # pylint: disable=unused-import, wrong-import-order
+
 
 # ----------------------------------------------------------------------
 class NaturalOrderGrouper(TyperGroup):
@@ -47,9 +52,6 @@ def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
     help="Filename that contains template configuration values; see https://cookiecutter.readthedocs.io/en/stable/advanced/user_config.html for more info.",
 )
 
-_overwrite_option = typer.Option(
-    "--overwrite", help="Overwrite the contents of the output directory if it exists."
-)
 _replay_option = typer.Option(
     "--replay", help="Do not prompt for input, instead read from saved json."
 )
@@ -79,7 +81,6 @@ def FrozenExecute(
             Path, typer.Argument(resolve_path=True, help="Directory to populate.")
         ],
         configuration_filename: Annotated[Optional[Path], _configuration_filename_option] = None,
-        overwrite: Annotated[bool, _overwrite_option] = False,
         replay: Annotated[bool, _replay_option] = False,
         version: Annotated[bool, _version_option] = False,
     ) -> None:
@@ -93,7 +94,6 @@ def FrozenExecute(
         _ExecuteOutputDir(
             output_dir,
             configuration_filename,
-            overwrite=overwrite,
             replay=replay,
             version=version,
         )
@@ -110,14 +110,12 @@ def StandardExecute(
             Path, typer.Argument(file_okay=False, resolve_path=True, help="Directory to populate.")
         ],
         configuration_filename: Annotated[Optional[Path], _configuration_filename_option] = None,
-        overwrite: Annotated[bool, _overwrite_option] = False,
         replay: Annotated[bool, _replay_option] = False,
         version: Annotated[bool, _version_option] = False,
     ) -> None:
         _ExecuteOutputDir(
             output_dir,
             configuration_filename,
-            overwrite=overwrite,
             replay=replay,
             version=version,
         )
@@ -133,7 +131,6 @@ def _ExecuteOutputDir(
     output_dir: Path,
     configuration_filename: Optional[Path],
     *,
-    overwrite: bool,
     replay: bool,
     version: bool,
 ) -> None:
@@ -146,7 +143,7 @@ def _ExecuteOutputDir(
         output_dir=str(output_dir),
         config_file=str(configuration_filename) if configuration_filename is not None else None,
         replay=replay,
-        overwrite_if_exists=overwrite,
+        overwrite_if_exists=True,
         accept_hooks=True,
     )
 

src/PythonProjectBootstrapper/python_project/cookiecutter.json

@@ -1,4 +1,30 @@
 {
     "name": "<your name>",
-    "__empty_dir": ""
+    "email": "<your email>",
+
+    "project_description": "<your project description>",
+
+    "license": [
+        "MIT",
+        "Apache-2.0",
+        "BSD-3-Clause-Clear",
+        "GPL-3.0-or-later",
+        "BSL-1.0"
+    ],
+
+    "gist_id": "<your gist id>",
+
+    "github_url": "https://github.com",
+    "github_username": "<your github username>",
+    "github_project_name": "<your github repository>",
+    "pypi_project_name": "{{ cookiecutter.github_project_name }}",
+
+    "create_docker_image": "no",
+
+    "__empty_dir": "",
+
+    "__prompts__": {
+    },
+
+    "_extensions": ["local_extensions.pypi_string"]
 }

src/PythonProjectBootstrapper/python_project/hooks/post_gen_project.py

@@ -1,10 +1,40 @@
 # ----------------------------------------------------------------------
-# |
-# |  Copyright Scientific Software Engineering Center at Georgia Tech 2024
-# |  Distributed under the MIT License.
-# |
+#
+# Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# Distributed under the MIT License.
+#
 # ----------------------------------------------------------------------
+import shutil
+import sys
+import textwrap
+
+from pathlib import Path
+from typing import Callable
+
+from dbrownell_Common import PathEx
 from rich import print
 
 
+# ----------------------------------------------------------------------
+def UpdateLicenseFile():
+    this_dir = Path.cwd()
+    licenses_dir = PathEx.EnsureDir(this_dir / "Licenses")
+
+    license_name = "{{ cookiecutter.license }}"
+
+    if license_name == "BSL-1.0":
+        source_file = licenses_dir / "BST-1.0_LICENSE_1_0.txt"
+    else:
+        source_file = licenses_dir / "{}_LICENSE.txt".format(license_name)
+
+    PathEx.EnsureFile(source_file)
+    dest_file = this_dir / source_file.name[len(license_name) + 1 :]
+
+    shutil.copy(source_file, dest_file)
+    shutil.rmtree(licenses_dir)
+
+
+UpdateLicenseFile()
+
+
 print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())

src/PythonProjectBootstrapper/python_project/hooks/pre_gen_project.py

@@ -0,0 +1,27 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+errors: list[str] = []
+
+# fmt: off
+if "{{ cookiecutter.name }}".startswith("<") and "{{ cookiecutter.name }}".endswith(">"):
+    errors.append('name ("{{ cookiecutter.name }}")')
+if "{{ cookiecutter.email }}".startswith("<") and "{{ cookiecutter.email }}".endswith(">"):
+    errors.append('email ("{{ cookiecutter.email }}")')
+if "{{ cookiecutter.project_description }}".startswith("<") and "{{ cookiecutter.project_description }}".endswith(">"):
+    errors.append('project_description ("{{ cookiecutter.project_description }}")')
+if "{{ cookiecutter.gist_id }}".startswith("<") and "{{ cookiecutter.gist_id }}".endswith(">"):
+    errors.append('gist_id ("{{ cookiecutter.gist_id }}")')
+if "{{ cookiecutter.github_username }}".startswith("<") and "{{ cookiecutter.github_username }}".endswith(">"):
+    errors.append('github_username ("{{ cookiecutter.github_username }}")')
+# fmt: on
+
+if errors:
+    raise Exception(
+        "Required data has not been populated:\n{}".format(
+            "\n".join("    - {}".format(e) for e in errors)
+        )
+    )

src/PythonProjectBootstrapper/python_project/local_extensions.py

@@ -0,0 +1,13 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+from cookiecutter.utils import simple_filter
+
+
+# ----------------------------------------------------------------------
+@simple_filter
+def pypi_string(value):
+    return value.lower().replace("_", "-")

src/PythonProjectBootstrapper/python_project/templates/python_header.py

@@ -0,0 +1,6 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) {% now 'utc', '%Y' %} {{ cookiecutter.name }}
+# |  Distributed under the {{ cookiecutter.license }} License.
+# |
+# ----------------------------------------------------------------------