moved cookie to toml

Author: btr1975

.coveragerc

@@ -0,0 +1,27 @@
+# Makefile for project needs
+# Author: Ben Trachtenberg
+# Version: 1.0.0
+#
+
+.PHONY: all info coverage pytest black
+
+info:
+	@echo "make options"
+	@echo "    black     To format code with black"
+	@echo "    coverage  To run coverage and display ASCII and output to htmlcov"
+	@echo "    pytest    To run pytest with verbose option"
+
+all: coverage black pylint
+
+coverage:
+	@pytest --cov --cov-report=html -vvv
+
+pytest:
+	@pytest --cov -vvv
+
+pylint:
+	@pylint hooks/
+
+black:
+	@black hooks/
+	@black tests/

Makefile

@@ -1,6 +1,7 @@
 """
 post generation hooks for cookiecutter to remove unneeded files
 """
+
 from typing import List
 import os
 import shutil
@@ -19,6 +20,7 @@
     '{% if cookiecutter.container_runtime == "docker" %}containers/Containerfile{% endif %}',
 ]
 
+
 def remove_paths(paths_to_remove: List[str]) -> None:
     """Remove files and directories
 
@@ -35,7 +37,7 @@ def remove_paths(paths_to_remove: List[str]) -> None:
                 shutil.rmtree(path)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     remove_paths(REMOVE_PATHS_NO_WEBPAGES)
     remove_paths(REMOVE_PATHS_PODMAN)
     remove_paths(REMOVE_PATHS_DOCKER)

hooks/post_gen_project.py

@@ -1,6 +1,7 @@
 """
 pre generation hooks for cookiecutter to validate data
 """
+
 import re
 import sys
 
@@ -16,7 +17,7 @@ def validate_no_spaces(arg_name: str, human_readable_name: str) -> None:
     :rtype: None
     :return: Nothing it exits if the arg_name is invalid
     """
-    arg_regex = r'^\S+$'
+    arg_regex = r"^\S+$"
     if not re.match(arg_regex, arg_name):
         print(f'ERROR: "{arg_name}" is not a valid {human_readable_name} no spaces allowed!')
         sys.exit(1)
@@ -33,7 +34,7 @@ def validate_no_spaces_begin_or_end(arg_name: str, human_readable_name: str) ->
     :rtype: None
     :return: Nothing it exits if the arg_name is invalid
     """
-    arg_regex = r'^\S.*\S$'
+    arg_regex = r"^\S.*\S$"
     if not re.match(arg_regex, arg_name):
         print(f'ERROR: "{arg_name}" is not a valid {human_readable_name} no spaces allowed at the beginning or ending!')
         sys.exit(1)
@@ -50,7 +51,7 @@ def validate_semantic_version(arg_name: str, human_readable_name: str) -> None:
     :rtype: None
     :return: Nothing it exits if the arg_name is invalid
     """
-    arg_regex = r'^\d+\.\d+\.\d+$'
+    arg_regex = r"^\d+\.\d+\.\d+$"
     if not re.match(arg_regex, arg_name):
         print(f'ERROR: "{arg_name}" is not a valid {human_readable_name} should be semantic X.X.X!')
         sys.exit(1)
@@ -67,7 +68,7 @@ def validate_https_url(arg_name: str, human_readable_name: str) -> None:
     :rtype: None
     :return: Nothing it exits if the arg_name is invalid
     """
-    arg_regex = r'^https://\S+$'
+    arg_regex = r"^https://\S+$"
     if not re.match(arg_regex, arg_name):
         print(f'ERROR: "{arg_name}" is not a valid {human_readable_name} should start with https://!')
         sys.exit(1)
@@ -84,22 +85,27 @@ def validate_numbers_letters_hyphens(arg_name: str, human_readable_name: str) ->
     :rtype: None
     :return: Nothing it exits if the arg_name is invalid
     """
-    arg_regex = r'^([A-Z]|[a-z]|[0-9]|-{1})+$'
+    arg_regex = r"^([A-Z]|[a-z]|[0-9]|-{1})+$"
     if not re.match(arg_regex, arg_name):
         print(f'ERROR: "{arg_name}" is not a valid {human_readable_name} should be numbers, letters and hyphens!')
         sys.exit(1)
 
 
-if __name__ == '__main__':
-    validate_no_spaces_begin_or_end(arg_name='{{ cookiecutter.full_name }}',
-                                    human_readable_name='full_name')  # pragma: no cover
-    validate_no_spaces(arg_name='{{ cookiecutter.email }}', human_readable_name='email')  # pragma: no cover
-    validate_no_spaces(arg_name='{{ cookiecutter.git_username }}',
-                       human_readable_name='git_username')  # pragma: no cover
-    validate_numbers_letters_hyphens(arg_name='{{ cookiecutter.git_repo_name }}',
-                                     human_readable_name='git_repo_name')  # pragma: no cover
-    validate_https_url(arg_name='{{ cookiecutter.git_url }}', human_readable_name='git_url')  # pragma: no cover
-    validate_no_spaces_begin_or_end(arg_name='{{ cookiecutter.app_description }}',
-                                    human_readable_name='app_description')  # pragma: no cover
-    validate_semantic_version(arg_name='{{ cookiecutter.app_version }}',
-                              human_readable_name='app_version')  # pragma: no cover
+if __name__ == "__main__":
+    validate_no_spaces_begin_or_end(
+        arg_name="{{ cookiecutter.full_name }}", human_readable_name="full_name"
+    )  # pragma: no cover
+    validate_no_spaces(arg_name="{{ cookiecutter.email }}", human_readable_name="email")  # pragma: no cover
+    validate_no_spaces(
+        arg_name="{{ cookiecutter.git_username }}", human_readable_name="git_username"
+    )  # pragma: no cover
+    validate_numbers_letters_hyphens(
+        arg_name="{{ cookiecutter.git_repo_name }}", human_readable_name="git_repo_name"
+    )  # pragma: no cover
+    validate_https_url(arg_name="{{ cookiecutter.git_url }}", human_readable_name="git_url")  # pragma: no cover
+    validate_no_spaces_begin_or_end(
+        arg_name="{{ cookiecutter.app_description }}", human_readable_name="app_description"
+    )  # pragma: no cover
+    validate_semantic_version(
+        arg_name="{{ cookiecutter.app_version }}", human_readable_name="app_version"
+    )  # pragma: no cover

hooks/pre_gen_project.py

@@ -0,0 +1,42 @@
+@ECHO OFF
+REM Makefile for project needs
+REM Author: Ben Trachtenberg
+REM Version: 1.0.0
+REM
+
+IF "%1" == "all" (
+    pytest --cov --cov-report=html -vvv
+    black hooks\
+    black tests\
+    pylint hooks\
+    GOTO END
+)
+
+IF "%1" == "coverage" (
+    pytest --cov --cov-report=html -vvv
+    GOTO END
+)
+
+IF "%1" == "pylint" (
+    pylint hooks\
+    GOTO END
+)
+
+IF "%1" == "pytest" (
+    pytest --cov -vvv
+    GOTO END
+)
+
+IF "%1" == "black" (
+    black hooks\
+    black tests\
+    GOTO END
+)
+
+@ECHO make options
+@ECHO     coverage  To run coverage and display ASCII and output to htmlcov
+@ECHO     black     To format the code with black
+@ECHO     pylint    To run pylint
+@ECHO     pytest    To run pytest with verbose option
+
+:END