[NEW] Python Generator v2.5.3

Release v2.5.3

Author: boromir674

.github/workflows/ci.yml

@@ -32,6 +32,15 @@ jobs:
       installation_mode: 'edit'
       python_version: '3.10'
       platform: 'ubuntu-latest'
+      # pytest_args: '-k test_gold -ra --run-requires_uv --run-network_bound -vvs --cov --cov-report=term-missing --cov-report=html:test-edit/htmlcov --cov-context=test --cov-report=xml:coverage.test-edit.xml -n auto tests'
+
+  codecov:
+    needs: code
+    # allow both code success and fail (but not skip)
+    if: always() && contains(fromJSON('["success", "failure"]'), needs.code.result) && vars.OV_CODECOV != 'false'
+    uses: ./.github/workflows/codecov-job.yml
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   # Build PACKAGE SDist and run Test Suite against it
   sdist:  ## Unless override, default trigger 'always'
@@ -47,7 +56,7 @@ jobs:
   wheel:  ## Unless override, default trigger 'always'
     uses: ./.github/workflows/test-python.yml
     with:
-      default_trigger: true
+      default_trigger: false
       override: '${{ vars.OV_WHEEL }}'
       installation_mode: 'wheel'
       upload_distro: true
@@ -57,7 +66,8 @@ jobs:
   # BUILD ALL WHEELS and run Test Suite against them
   ## Unless override, default trigger 'always'
   all_wheels:
-    if: vars.OV_ALL_WHEELS != 'false'  # Unless override, default trigger 'always'
+    if: false
+    # if: vars.OV_ALL_WHEELS != 'false'  # Unless override, default trigger 'always'
     runs-on: ubuntu-latest
     env:
       module_name: cookiecutter_python
@@ -127,7 +137,7 @@ jobs:
   # RUN INTEGRATION TESTS: slower due to automated installations involved via pip
   ## Unless override, default trigger is (only) on PR to dev
   test_integration:
-    if: always() || vars.OV_TEST_INTEGRATION == 'true' || (vars.OV_SCA != 'false' && github.event_name == 'pull_request' && github.base_ref == 'dev')
+    if: vars.OV_TEST_INTEGRATION == 'true' || (vars.OV_SCA != 'false' && github.event_name == 'pull_request' && github.base_ref == 'dev')
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -175,7 +185,7 @@ jobs:
   # CROSS PLATFORM TESTING: 15s on Ubuntu, 25 on mac, 35 on windows
   ## Unless override, default trigger is (only) on PR to dev
   sample_matrix_test:
-    if: always() || vars.OV_MATRIX_TEST == 'true' || (vars.OV_MATRIX_TEST != 'false' && github.event_name == 'pull_request' && github.base_ref == 'dev')
+    if: vars.OV_MATRIX_TEST == 'true' || (vars.OV_MATRIX_TEST != 'false' && github.event_name == 'pull_request' && github.base_ref == 'dev')
     runs-on: ${{ matrix.platform }}
     # trigger if event is pr to dev
     strategy:
@@ -238,6 +248,7 @@ jobs:
           fi
           pytest -ra --run-requires_uv --run-network_bound -vvs
 
+
 ## PYDEPS
 
 ## TYPE CHECK

.github/workflows/codecov-job.yml

@@ -0,0 +1,38 @@
+## Codecov Upload - Reusable Workflow ##
+
+on:
+  workflow_call:
+    secrets:
+      CODECOV_TOKEN:
+        required: true
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Get Codecov binary
+        run: |
+          curl -Os https://uploader.codecov.io/latest/linux/codecov
+          chmod +x codecov
+
+      # DOWNLOAD XML FILES FROM ARTIFACTS
+      - name: Download All Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: coverage
+          pattern: coverage-*
+          merge-multiple: true
+
+      - run: ls -R coverage
+
+      # UPLOAD XML FILES TO CODECOV
+      - name: Upload Coverage Reports to Codecov
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}  # this is "read" from inputs
+        run: |
+          for file in coverage/coverage*.xml; do
+            OS_NAME=$(echo $file | sed -E "s/coverage-(\w\+)-/\1/")
+            PY_VERSION=$(echo $file | sed -E "s/coverage-\w\+-(\d\.)\+/\1/")
+            ./codecov -f $file -e "OS=$OS_NAME,PYTHON=$PY_VERSION" --flags unittests --verbose
+            echo "[INFO] Sent to Codecov: $file !"
+          done

.github/workflows/dev_pr_validation.yml

@@ -187,6 +187,15 @@ jobs:
     outputs:
       PEP_VERSION: ${{ steps.build.outputs.PEP_VERSION }}
 
+  # CODECOV Upload of COVERAGE reports
+  codecov:
+    if: always() && contains(fromJSON('["success", "failure"]'), needs.cross_platform_tests.result)
+    needs: cross_platform_tests
+    uses: ./.github/workflows/codecov-job.yml
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+
   # STATIC CODE ANALYSIS: mypy, ruff, isort, black, bandit, mccabe, prospector, etc
   sca:
     uses: ./.github/workflows/sca-job.yml
@@ -221,35 +230,6 @@ jobs:
       python_version: '3.11'
 
 
-  # CODECOV Upload of COVERAGE reports
-  codecov_coverage_host:
-    if: always() && github.event_name == 'pull_request' && github.base_ref == 'release'
-    runs-on: ubuntu-latest
-    needs: cross_platform_tests
-    steps:
-      - uses: actions/checkout@v4
-      - name: Get Codecov binary
-        run: |
-          curl -Os https://uploader.codecov.io/latest/linux/codecov
-          chmod +x codecov
-
-      - name: Download All Artifacts
-        uses: actions/download-artifact@v4
-        with:
-          path: coverage
-          pattern: coverage-*
-          merge-multiple: true
-
-      - run: ls -R coverage
-
-      - name: Upload Coverage Reports to Codecov
-        run: |
-          for file in coverage/coverage*.xml; do
-            OS_NAME=$(echo $file | sed -E "s/coverage-(\w\+)-/\1/")
-            PY_VERSION=$(echo $file | sed -E "s/coverage-\w\+-(\d\.)\+/\1/")
-            ./codecov -f $file -e "OS=$OS_NAME,PYTHON=$PY_VERSION" --flags unittests --verbose
-            echo "Sent to Codecov: $file !"
-          done
 
   ## DOCKER BUILD and PUBLISH ON DOCKERHUB ##
   # Ref Page: https://automated-workflows.readthedocs.io/en/main/ref_docker/

.github/workflows/test-python.yml

@@ -39,6 +39,14 @@ on:
         default: 'ubuntu-latest'
         description: "Platform to use for the job. Default is 'ubuntu-latest'"
         type: string
+
+      # Pytest Settings #
+      pytest_args:
+        required: false
+        description: "Arguments to pass to pytest. Pass value to override the default value"
+        type: string
+
+
 jobs:
   test:
     if: inputs.override == 'true' || (inputs.override != 'false' && inputs.default_trigger == true)
@@ -94,6 +102,9 @@ jobs:
 
           uv pip install --no-deps ${{ inputs.installation_mode == 'edit' && '-e .' || inputs.installation_mode == 'sdist' && 'dist/*.tar.gz' || inputs.installation_mode == 'wheel' && 'dist/*.whl' }}
 
+      - name: Compute Pytest default Arguments
+        id: pytest_args
+        run: echo DEFAULT_PYTEST_ARGS='-ra --run-requires_uv --run-network_bound -vvs --cov --cov-report=term-missing --cov-report=html:test-${{ inputs.installation_mode }}/htmlcov --cov-context=test --cov-report=xml:coverage.test-${{ inputs.installation_mode }}.xml -n auto tests' >> $GITHUB_OUTPUT
 
       #### Run Test Suite against the package and measure Coverage ####
       - name: Run Tests and measure Coverage
@@ -104,6 +115,7 @@ jobs:
           BUG_LOG_DEL_WIN: 'permission_error'  # required on Windows Job
           PY_WHEEL: 1 # required on Windows Job
           COVERAGE_FILE: '.coverage.${{ inputs.installation_mode }}'
+          PYTEST_ARGS: "${{ inputs.pytest_args || steps.pytest_args.outputs.DEFAULT_PYTEST_ARGS }}"
         run: |
           if [[ "${{ matrix.platform }}" == "windows-latest" ]]; then
             echo "[INFO] Activating virtual environment for Windows"
@@ -114,10 +126,7 @@ jobs:
             . .venv/bin/activate
           fi
 
-          pytest -ra --run-requires_uv --run-network_bound -vvs --cov --cov-report=term-missing \
-            --cov-report=html:test-${{ inputs.installation_mode }}/htmlcov --cov-context=test \
-            --cov-report=xml:coverage.test-${{ inputs.installation_mode }}.xml \
-            -n auto tests
+          pytest ${{ env.PYTEST_ARGS }}
 
       ## Code Coverage ## TODO; enable combine by moving each .coverage file to other dir to avoid override of subsequent coverage invocations with pytest
       - name: "Discover and Combine Coverage data into XML Reports"

.github/workflows/test.yaml

@@ -167,32 +167,11 @@ jobs:
       # artifact_name: 'dist'
 
   codecov_coverage_host:
-    runs-on: ubuntu-latest
     needs: test
-    steps:
-    - uses: actions/checkout@v4
-    - name: Get Codecov binary
-      run: |
-        curl -Os https://uploader.codecov.io/latest/linux/codecov
-        chmod +x codecov
-
-    - name: Download All Artifacts
-      uses: actions/download-artifact@v4
-      with:
-        path: coverage
-        pattern: coverage-*
-        merge-multiple: true
-
-    - run: ls -R coverage
-
-    - name: Upload Coverage Reports to Codecov
-      run: |
-        for file in coverage/coverage*.xml; do
-          OS_NAME=$(echo $file | sed -E "s/coverage-(\w\+)-/\1/")
-          PY_VERSION=$(echo $file | sed -E "s/coverage-\w\+-(\d\.)\+/\1/")
-          ./codecov -f $file -e "OS=$OS_NAME,PYTHON=$PY_VERSION" --flags unittests --verbose
-          echo "Sent to Codecov: $file !"
-        done
+    if: always() && contains(fromJSON('["success", "failure"]'), needs.test.result)
+    uses: ./.github/workflows/codecov-job.yml
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   ## STATIC CODE ANALYSIS: mypy, ruff, isort, black, bandit, mccabe, prospector, etc
   sca:

CHANGELOG.rst

@@ -3,6 +3,18 @@ Changelog
 =========
 
 
+2.5.3 (2024-04-18)
+==================
+
+Initial goal was to simplify the tests.  
+In the process:
+
+- we did that
+- increased code coverage
+- fixed a bug with the -f flag when used with the same gen params and on the same output location folder
+- improved user experience on the cli.terminal with better messages
+
+
 2.5.2 (2024-04-14)
 ==================
 

README.rst

@@ -275,9 +275,9 @@ Free/Libre and Open Source Software (FLOSS)
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.5.2/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.5.3/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v2.5.2..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v2.5.3..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)
@@ -312,9 +312,10 @@ Free/Libre and Open Source Software (FLOSS)
 .. Code Climate CI
 .. Code maintainability & Technical Debt
 
+
 .. |maintainability| image:: https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability
    :alt: Maintainability
-   :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/
+   :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability
 
 .. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package
     :alt: Code Climate technical debt

docs/conf.py

@@ -30,7 +30,7 @@
 author = 'Konstantinos Lampridis'
 
 # The full version, including alpha/beta/rc tags
-release = '2.5.2'
+release = '2.5.3'
 
 # -- General configuration ---------------------------------------------------
 

pyproject.toml

@@ -14,7 +14,7 @@ build-backend = "poetry.core.masonry.api"
 name = "cookiecutter_python"
 ### ... ###
 
-version = "2.5.2"
+version = "2.5.3"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.rst"
 license = "AGPL-3.0-only"
@@ -74,7 +74,7 @@ maintainers = [
 license = {text = "AGPL-3.0-only"}
 
 name = "cookiecutter_python"
-version = "2.5.2"
+version = "2.5.3"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.rst"
 # keywords = []
@@ -132,7 +132,7 @@ docslive = [
 typing = [
     "types-requests~=2.27.26",
     "types-pyyaml<7.0.0.0,>=6.0.12.5",
-    "mypy>=1.0.0",
+    "mypy==1.2.0",
     "pytest>=7.4.4",
 ]
 

scripts/mypy.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env sh
+
+## Run Mypy against Code
+
+# Env Required: .lint-env
+
+set -e
+
+# if env notr found exit with error
+if [ ! -d .lint-env ]; then
+  echo "No .lint-env found, please run 'uv venv .lint-env' first"
+  exit 1
+fi
+
+
+# uv export --no-emit-project --no-dev --extra typing --frozen --format requirements-txt -o prod+type.txt
+
+# . .lint-env/bin/activate
+
+# uv pip install -r prod+type.txt
+
+# set mypy environment
+export MYPYPATH=${MYPYPATH:-src/stubs}
+
+# DRYness
+PKG=${PGK:-src/cookiecutter_python}
+
+mypy --show-error-codes --check-untyped-defs \
+    --exclude tests/data \
+    "${PKG}/hooks" \
+    "${PKG}/backend" "${PKG}/handle" \
+    "${PKG}/utils.py" "${PKG}/exceptions.py" \
+    "${PKG}/cli.py" "${PKG}/cli_handlers.py" \
+    "${PKG}/__main__.py" "${PKG}/__init__.py" \
+    tests