update readme

Jenkinsfile

@@ -35,9 +35,9 @@ def _MkDocsWebCredentials    = "2c5b684e-3787-4b37-8aca-b3dd4a383fe2"
 def _PypiCredentials         = "Pypi"
 
 
-def badge_coverage      = addEmbeddableBadgeConfiguration(id: "coverage",   subject: "coverage")
-def badge_complexity    = addEmbeddableBadgeConfiguration(id: "complexity", subject: "code complexity")
-def badge_quality       = addEmbeddableBadgeConfiguration(id: "quality",    subject: "quality score")
+def badge_coverage          = addEmbeddableBadgeConfiguration(id: "coverage",   subject: "coverage")
+def badge_maintainability   = addEmbeddableBadgeConfiguration(id: "maintainability", subject: "maintainability")
+def badge_quality           = addEmbeddableBadgeConfiguration(id: "quality",    subject: "quality score")
 
 // commands Helper: /!\ Made for GITEA /!\
 String determineRepoUserName() {
@@ -89,7 +89,7 @@ int GetCoverageValue(String CoverageFilePath,String XPath)
 
 String getColorScale(BigDecimal value)
 {
-  if( value >9)         { return "gold"}
+  if( value >9)         { return "Goldenrod"}
   else if( value >6)    { return "seagreen"}
   else if( value >4)    { return "orange"}
   else if( value >2)    { return "darkred"}
@@ -102,7 +102,7 @@ String getColorScale_reversed(BigDecimal value)
   else if( value >6)    { return "darkred"}
   else if( value >4)    { return "orange"}
   else if( value >2)    { return "seagreen"}
-  else                  { return "gold"}
+  else                  { return "Goldenrod"}
 }
 
 int GetCoverageValue_lines_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-valid") }
@@ -375,7 +375,7 @@ pipeline {
 						def wheelPath = findFiles(glob: "**/dist/*.whl")[0]
 						echo "wheel artifact path: $wheelPath"
 						// install the package, with *test* optionnal packages, as user
-						sh(". ~/TEST_ENV/bin/activate && pip install --find-links dist/ ${PY_PROJECT_NAME} .[test,coverage-check,quality-check,type-check,doc-gen]")
+						sh(". ~/TEST_ENV/bin/activate && pip install --find-links dist/ ${PY_PROJECT_NAME} .[test,coverage-check,quality-check,type-check,doc-gen,complexity-check]")
 					}
 				}
 			}
@@ -387,10 +387,12 @@ pipeline {
                     sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check")
                     script {
                         def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json"
-                        quality_score = jsonObj["GlobalScore"]
-                        badge_quality.setStatus(Double.toString(quality_score))
+                        quality_score = new BigDecimal(jsonObj["GlobalScore"])
+                        sz_quality_score = quality_score.setScale(2, RoundingMode.HALF_EVEN).toString()
+                        badge_quality.setStatus(sz_quality_score)
                         badge_quality.setColor(getColorScale(quality_score))
                     }
+                    sh(". ~/TEST_ENV/bin/activate && python -m helpers --complexity-check")
                 }
             }
             post {
@@ -445,6 +447,14 @@ pipeline {
                         style: 'stackedArea',
                         keepRecords: true,
                         numBuilds: ''])
+                        
+                 plot([ csvFileName: 'plot-4ceb9ee2-ca78-11ed-afa1-0242ac120002.csv',
+                        csvSeries: [[ file: 'gitrepo/helpers-results/complexity_check/MI.csv', inclusionFlag: 'INCLUDE_BY_STRING',exclusionValues: 'MeanMaintainability', url: '']],
+                        group: 'metrics',
+                        title: 'maintainability',
+                        style: 'stackedArea',
+                        keepRecords: true,
+                        numBuilds: ''])
             }
         }
         
@@ -470,12 +480,23 @@ pipeline {
                         full_rate = new BigDecimal( 10*(GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 )
                         sz_full_rate = full_rate.setScale(2, RoundingMode.HALF_EVEN).toString()
                         badge_coverage.setStatus(sz_full_rate)
-                        badge_quality.setColor(getColorScale(full_rate))
+                        badge_coverage.setColor(getColorScale(full_rate))
                         
-                        complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path))
-                        sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString()
-                        badge_complexity.setStatus(sz_complexity)
-                        badge_quality.setColor(getColorScale_reversed(complexity))
+                        //complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path))
+                        //sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString()
+                        //badge_complexity.setStatus(sz_complexity)
+                        //badge_quality.setColor(getColorScale_reversed(complexity))
+                        
+                        //badge_maintainability
+                        records = readCSV file: 'helpers-results/complexity_check/MI.csv'
+                        maintainability = records[1][1]
+                        badge_maintainability.setStatus(maintainability)
+                        
+                        if     ( maintainability == 'D')  { badge_maintainability.setColor(  "dimgrey")}
+                        else if( maintainability == 'C')  { badge_maintainability.setColor(  "darkred")}
+                        else if( maintainability == 'B')  { badge_maintainability.setColor(  "orange")}
+                        else if( maintainability == 'A')  { badge_maintainability.setColor(  "seagreen")}
+                        else if( maintainability == 'A+') { badge_maintainability.setColor(  "Goldenrod")} 
                     }
                 }
 			}

README.md

@@ -1,9 +1,9 @@
 ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=status&status=active&color=seagreen)
 ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue)
 ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}})
-![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage&color=darkviolet)
-![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=complexity&color=darkviolet)
-![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality&color=darkviolet)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=maintainability)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality)
 ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal)
 
 ![](docs-static/Library.jpg)
@@ -24,6 +24,7 @@ Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pygitv
     - get current version (bumped)
     - convert / switch from SemVer to PEP440 (both ways)
     - automatic version format detection (SemVer by default)
+    - Get commit message history
     
 ## Options
     - restrict to same branch

helpers/__main__.py

@@ -23,6 +23,7 @@ if __package__ == "helpers":
     from .unit_test import unit_test
     from .doc_gen import doc_gen
     from .changelog_gen import changelog_gen
+    from .complexity_check import complexity_check
 else:
     # when calling the __main__.py file (from IDE)
     from helpers.types_check import types_check
@@ -30,6 +31,7 @@ else:
     from helpers.unit_test import unit_test
     from helpers.doc_gen import doc_gen
     from helpers.changelog_gen import changelog_gen
+    from helpers.complexity_check import complexity_check
 
 logging.getLogger().setLevel(logging.INFO)
 
@@ -59,6 +61,8 @@ if __name__ == "__main__":
 
     parser.add_argument("-clg", "--changelog-gen", dest="changeloggen", action="store_true", help="enable changelog generation")
 
+    parser.add_argument("-cpc", "--complexity-check", dest="complexitycheck", action="store_true", help="enable complexity check")
+
     args = parser.parse_args()
 
     ##################################
@@ -73,6 +77,7 @@ if __name__ == "__main__":
     # args.docgen         = True
     # args.docgenpdf      = True
     # args.changeloggen   = True
+    # args.complexitycheck = True
 
     helpers = []
     if args.typecheck == True:
@@ -102,6 +107,9 @@ if __name__ == "__main__":
     if args.changeloggen == True:
         helpers.append(changelog_gen)
 
+    if args.complexitycheck == True:
+        helpers.append(complexity_check)
+
     for helper in helpers:
         helper.set_context(project_rootdir_path, pyproject)
         helper.reset_result_dir()

helpers/complexity_check.py

@@ -0,0 +1,70 @@
+# pyChaChaDummyProject (c) by chacha
+#
+# pyChaChaDummyProject is licensed under a
+# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
+#
+# You should have received a copy of the license along with this
+# work.  If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+# from pathlib import Path
+# import os
+import statistics
+import csv
+from json import loads as JSON_LOADS
+from radon.complexity import cc_rank, SCORE
+from radon.cli import Config
+from radon.cli.harvest import CCHarvester, HCHarvester, MIHarvester
+
+from .helper_base import helper_withresults_base
+from pprint import pprint
+
+
+class complexity_check(helper_withresults_base):
+    @classmethod
+    def do_job(cls):
+        config = Config(
+            exclude="__init__\.py",
+            ignore=None,
+            order=SCORE,
+            show_closures=False,
+            no_assert=True,
+            min="A",
+            max="F",
+            multi=False,
+        )
+
+        h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        res = JSON_LOADS(h)
+
+        with open(cls.get_result_dir() / "MI.json", "w", newline="") as oFile:
+            oFile.write(h)
+
+        mean = statistics.mean(_["mi"] for _ in res.values())
+
+        if mean >= 65:
+            rank = "A+"
+        elif mean >= 20:
+            rank = "A"
+        elif mean >= 10:
+            rank = "B"
+        else:
+            rank = "C"
+
+        RES_MI = {"MeanMaintainability": mean, "MaintainabilityIndex": rank}
+        with open(cls.get_result_dir() / "MI.csv", "w", newline="") as oFile:
+            writer = csv.DictWriter(oFile, fieldnames=RES_MI.keys())
+            writer.writeheader()
+            writer.writerow(RES_MI)
+
+        config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False)
+        h = CCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        with open(cls.get_result_dir() / "CC.json", "w", newline="") as oFile:
+            oFile.write(h)
+
+        config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", by_function=None)
+        h = HCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        with open(cls.get_result_dir() / "HC.json", "w", newline="") as oFile:
+            oFile.write(h)

helpers/doc_gen.py

@@ -31,8 +31,6 @@ class doc_gen(helper_withresults_base):
 
     @classmethod
     def do_job(cls):
-        print(cls.project_rootdir_path)
-        print()
 
         # create doc root dir
         doc_path = cls.project_rootdir_path / "docs"

helpers/quality_check.py

@@ -60,6 +60,7 @@ class quality_check(helper_withresults_base):
             with redirect_stdout(StdOutput):
                 pylint_Run(
                     [
+                        "--load-plugins=pylint.extensions.mccabe",
                         "--output-format=json,parseable",
                         "--disable=invalid-name",
                         "--ignore=_version.py",

pyproject.toml

@@ -12,7 +12,6 @@ build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
 version_scheme= "post-release"
-# tag_regex="^(?:v)?(?P<version>\\d+\\.\\d+\\.\\d+)([\\.\\-\\+])?(?:.*)?"
 
 [project]
 name = "pygitversionhelper"
@@ -57,6 +56,7 @@ Tracker         = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper/issue
 [project.optional-dependencies]
 test              = ["junitparser>=2.8","junit2html>=30.1","xmlrunner>=1.7","mypy>=0.99" ]
 coverage-check    = ["coverage>=7.0"]
+complexity-check  = ["radon>=5.1"]
 quality-check     = ["pylint>=2.15","pylint-json2html>=0.4","pandas>=1.5"]
 type-check        = ["mypy[reports]>=0.99" ]
 doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0","pymdown-extensions>=9","mkdocs-markdownextradata-plugin","mkdocs-mermaid2-plugin"]