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") }
@@ -447,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: ''])
             }
         }
         
@@ -474,10 +482,21 @@ pipeline {
                         badge_coverage.setStatus(sz_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

@@ -2,7 +2,7 @@
 ![](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)
-![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=complexity)
+![](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)
 
@@ -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

@@ -77,7 +77,7 @@ if __name__ == "__main__":
     # args.docgen         = True
     # args.docgenpdf      = True
     # args.changeloggen   = True
-    args.complexitycheck = True
+    # args.complexitycheck = True
 
     helpers = []
     if args.typecheck == True:

helpers/complexity_check.py

@@ -11,6 +11,9 @@ 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
@@ -22,21 +25,46 @@ from pprint import pprint
 class complexity_check(helper_withresults_base):
     @classmethod
     def do_job(cls):
-        config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False)
+        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)
-        pprint(h.as_json())
+        h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        res = JSON_LOADS(h)
 
-        print()
+        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)
-        pprint(h.as_json())
-
-        print()
+        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)
-        pprint(h.as_json())
+        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)