[DEV] Better Code Architecture & More Tests

Release Cookiecutter Python Package v1.5.1

Author: boromir674

.github/biskotaki.yaml

@@ -9,6 +9,6 @@ default_context:
     author_email: k.lampridis@hotmail.com
     github_username: boromir674
     project_short_description: Project generated from the https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python cookiecutter
-    initialize_git_repo: no
+    initialize_git_repo: yes
     add_cli: no
     interpreters: {"supported-interpreters": ["3.6", "3.7", "3.8", "3.9", "3.10"]}

.github/workflows/test.yaml

@@ -50,9 +50,10 @@ jobs:
         echo "PKG_VERSION=$A" >> $GITHUB_ENV
 
     - name: Run Test Suite
-      run: tox -vv -s false
+      run: tox -vv -s false -- --run-network_bound
       env:
         PLATFORM: ${{ matrix.platform }}
+
     - name: Check for compliance with Python Best Practices
       run: |
         DIST_DIR=dist

.pylintrc

@@ -153,7 +153,8 @@ disable=print-statement,
         not-callable,
         unsubscriptable-object,
         protected-access,
-        invalid-metaclass
+        invalid-metaclass,
+        catching-non-exception
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -254,7 +255,7 @@ ignore-on-opaque-inference=yes
 
 # List of class names for which member attributes should not be checked (useful
 # for classes with dynamically set attributes). This supports the use of
-# qualified names.
+# qualified names. Solves `attr-defined` errors.
 ignored-classes=optparse.Values,
                 thread._local,
                 _thread._local,

CHANGELOG.rst

@@ -2,6 +2,31 @@
 Changelog
 =========
 
+1.5.1 (2022-06-20)
+==================
+
+The Update includes improved code Architecture and better Test code Coverage!
+Features shorter Unites of Code, more DRY and more Tests.
+
+Changes
+^^^^^^^
+
+test
+""""
+- add bandit tox env for discovering common security issues
+- verify commit message, author and email are the expected ones
+- git init, increase test code coverage
+
+refactor
+""""""""
+- reduce code
+- centralize subprocess run invocations
+
+ci
+""
+- enable network-bound tests to trigger integration testing of the `check_pypi` feature
+
+
 1.5.0 (2022-06-11)
 ==================
 

README.rst

@@ -196,9 +196,9 @@ For more complex use cases, you can modify the Template and also leverage all of
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.5.0/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.5.1/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.5.0..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.5.1..master
 
 .. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
     :alt: GitHub commits since latest release (by SemVer)

pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "poetry.core.masonry.api"
 ## Also renders on pypi as 'subtitle'
 [tool.poetry]
 name = "cookiecutter_python"
-version = "1.5.0"
+version = "1.5.1"
 description = "Yet another modern Python Package (pypi) with emphasis in CI/CD and automation."
 authors = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
 maintainers = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
@@ -97,9 +97,11 @@ software-patterns = "^1.3.0"
 requests-futures = "^1.0.0"
 PyInquirer = "^1.0.3"
 prompt-toolkit = "==1.0.14"
+gitpython = "^3.1"
 
 # A list of all of the optional dependencies, some of which are included in the
 # below `extras`. They can be opted into by apps.
+# "^" is the more conservative compared to "~"
 
 # Test: packages imported in test code and packages required for the "test runner"
 pytest = { version = ">= 6.2.4", optional = true }
@@ -128,6 +130,7 @@ test = [
     "pytest-explicit",
     "pytest-xdist",
     "pytest-object-getter",
+    "gitpython",
 ]
 docs = [
     "sphinx",
@@ -198,3 +201,12 @@ profile = 'black'
 
 [tool.software-release]
 version_variable = "src/cookiecutter_python/__init__.py:__version__"
+
+
+# BANDIT
+
+[tool.bandit]
+tests = []
+skips = [
+    "B101",
+]

src/cookiecutter_python/__init__.py

@@ -1 +1 @@
-__version__ = '1.5.0'
+__version__ = '1.5.1'

src/cookiecutter_python/backend/check_pypi_handler.py

@@ -9,12 +9,6 @@
 def _available_on_pypi(callback, package_name: str):
     try:
         res: bool = callback(package_name)
-    except ImportError as error:
-        print(error)
-        print(
-            "If you want to enable the 'check_pypi' feature, "
-            "Please also install the [check_pypi] requirements (see setup.cfg)"
-        )
     except ConnectionError as error:
         print(error, file=sys.stderr)
         print("Could not establish connection to pypi.")

src/cookiecutter_python/backend/error_handling/__init__.py

@@ -0,0 +1,3 @@
+from .handler_builder import HandlerBuilder
+
+__all__ = ['HandlerBuilder']

src/cookiecutter_python/backend/error_handling/handler_builder.py

@@ -0,0 +1,24 @@
+import json
+
+import click
+from software_patterns import SubclassRegistry
+
+
+class HandlerBuilder(metaclass=SubclassRegistry):
+    pass
+
+
+@HandlerBuilder.register_as_subclass('non-critical')
+class NonCriticalHandlerBuilder:
+    def __call__(self, error):
+        click.echo(error)
+
+
+@HandlerBuilder.register_as_subclass('critical')
+class CriticalHandlerBuilder:
+    def __call__(self, error):
+        click.echo('{}'.format(error.message))
+        click.echo('Error message: {}'.format(error.error.message))
+
+        context_str = json.dumps(error.context, indent=4, sort_keys=True)
+        click.echo('Context: {}'.format(context_str))