[NEW] Better Scripts, Better Configuration Files

Release Cookiecutter Python Pacakge v1.5.0

Author: boromir674

.bettercodehub.yml

@@ -0,0 +1,3 @@
+component_depth: 3
+languages:
+- python

.github/workflows/test.yaml

@@ -11,6 +11,7 @@ on:
     branches:
       - master
       - dev
+      - develop
     tags:
       - v*
 
@@ -21,10 +22,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest]
-        # platform: [macos-latest]
-        # python-version: ["3.6"]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
-
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -37,19 +35,24 @@ jobs:
         python -m pip install tox tox-gh-actions
 
     - name: Do Lint Checking
-      run: tox -e lint -vv -s false
+      run: |
+        tox -e lint -vv -s false
+        tox -e prospector -vv -s false
 
     - name: Do Type Checking
       run: tox -e type -vv -s false
 
     - name: Specify current package version to assist build tool
-      run: echo "PKG_VERSION=$(python scripts/parse_version.py)" >> $GITHUB_ENV
+      run: |
+        PARSER="src/cookiecutter_python/{{ cookiecutter.project_slug }}/scripts/parse_version.py"
+        A=$(python "${PARSER}")
+        echo $A
+        echo "PKG_VERSION=$A" >> $GITHUB_ENV
 
     - name: Run Test Suite
       run: tox -vv -s false
       env:
         PLATFORM: ${{ matrix.platform }}
-
     - name: Check for compliance with Python Best Practices
       run: |
         DIST_DIR=dist
@@ -58,7 +61,6 @@ jobs:
         mkdir "$DIST_DIR"
         mv ".tox/${DIST_DIR}/cookiecutter_python-${PKG_VERSION}.tar.gz" "${DIST_DIR}"
         mv ".tox/${DIST_DIR}/cookiecutter_python-${PKG_VERSION}-py3-none-any.whl" "${DIST_DIR}"
-
         tox -e check -vv -s false
 
     - name: Upload Source & Wheel distributions as Artefacts
@@ -99,5 +101,3 @@ jobs:
         flags: unittests
         name: codecov-umbrella
         verbose: true
-
-    # TODO find build tar.gz whl files and upload as artefacts

.prospector.yml

@@ -52,7 +52,10 @@ bandit:
 frosted:
   run: false
 
-pycodestyle:
+pep8:
+  run: false
+
+pep257:
   run: false
 
 mypy:

.pylintrc

@@ -152,7 +152,8 @@ disable=print-statement,
         redundant-keyword-arg,
         not-callable,
         unsubscriptable-object,
-        protected-access
+        protected-access,
+        invalid-metaclass
 
 # 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
@@ -227,9 +228,13 @@ notes=FIXME,
 contextmanager-decorators=contextlib.contextmanager
 
 # List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 (no-member) when accessed. Python regular
-# expressions are accepted.
-generated-members=_transform|self\.objects|self\._observers|subclasses|InteractiveDialog\.create
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted. Things coming from a metaclass or a dynamic attribute set.
+# Can solve E1101: Class 'X' has no 'y' member (no-member)
+generated-members=_transform|self\.objects|self\._observers|subclasses|
+      InteractiveDialog\.create|
+      exception_msg|
+      log_message
 
 # Tells whether missing members accessed in mixin class should be ignored. A
 # mixin class is detected if its name ends with "mixin" (case insensitive).
@@ -357,6 +362,8 @@ function-naming-style=snake_case
 #function-rgx=
 
 # Good variable names which should always be accepted, separated by a comma.
+# Can solves C0103: Variable name "x" doesn't conform to snake_case naming
+# style (invalid-name)
 good-names=i,
            j,
            k,
@@ -373,7 +380,6 @@ good-names=i,
            REGEX,
            cookiecutter
 
-
 # Good variable names regexes, separated by a comma. If names match any regex,
 # they will always be accepted
 good-names-rgxs=
@@ -521,14 +527,14 @@ callbacks=cb_,
 # Here you make pylint ignore variable names that seem to be undefined.
 # For example:
 # * Variables inside try/except statements that can potentially be undefined
-# * Variables that are part of templating (ie jinja, cookicutter)
+# * Variables that are part of templating (ie jinja, cookiecutter)
 #   and we expect them to be replaced at runtime, but statically seem erronouous for pylint
 # E0602: Undefined variable '<variable_name>' (undefined-variable)
 dummy-variables-rgx=cookiecutter|_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
 
 # Argument names that match this expression will be ignored. Default to name
 # with leading underscore.
-ignored-argument-names=_.*|^ignored_|^unused_|args|kwargs
+ignored-argument-names=_.*|^ignored_|^unused_|args|kwargs|questions|answers
 
 # Tells whether we should check for unused import in __init__ files.
 init-import=no

CHANGELOG.rst

@@ -2,6 +2,42 @@
 Changelog
 =========
 
+1.5.0 (2022-06-11)
+==================
+
+This release focused on improving the code architecture, reducing technical
+debt, decoupling components, cleaning code, fixing styling issues.
+
+It also features some updates in the Generated Project, with improved tox envs,
+cleaner python scripts and cleaner development tools' configuration files
+(such as .pylintrc, pyproject.toml, tox.ini).
+
+Changes
+^^^^^^^
+
+feature
+"""""""
+- document config settings, improve tox envs & scripts
+
+test
+""""
+- verify Generator can be invoked as python module: `python -m cookiecutter_python`
+
+refactor
+""""""""
+- dry code per string_sanitizer implementation
+- reduce code in cli.py by delegating error handling to the new cli_handlers.py module
+- reduce code of parse_version.py script
+- abstract input sanitization
+- reduce main code
+- decouple components
+- clean code, satisfy some todos, dry code
+
+ci
+""
+- use the template's parse_version script to reduce duplicate code
+
+
 1.4.1 (2022-06-07)
 ==================
 

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.4.1/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.0/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.4.1..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.5.0..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.4.1"
+version = "1.5.0"
 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>"]
@@ -86,14 +86,14 @@ exclude = [
 
 
 [tool.poetry.scripts]
-generate-python = 'cookiecutter_python.__main__:main'
+generate-python = 'cookiecutter_python.cli:main'
 
 
 [tool.poetry.dependencies]
 python = "^3.6"
 click = "^8"
 cookiecutter = "^1.7.3"
-software-patterns = "^1.2.1"
+software-patterns = "^1.3.0"
 requests-futures = "^1.0.0"
 PyInquirer = "^1.0.3"
 prompt-toolkit = "==1.0.14"

scripts/parse_version.py

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

src/cookiecutter_python/__init__.py

@@ -1,3 +1,8 @@
-from .cookiecutter_proxy import cookiecutter
+from .main import CheckPypiError, generate
+from .sanitization import sanitize
 
-__all__ = ['cookiecutter']
+__all__ = [
+    'generate',
+    'CheckPypiError',
+    'sanitize',
+]