Release v1.0.1

README.md

@@ -2,7 +2,7 @@
 
 pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics.
 
-[![License](https://img.shields.io/badge/license-bsd-3.svg)](https://choosealicense.com/licenses/bsd-3-clause/) [![Repo Status](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) [![CI](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml/badge.svg)](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-bsd-3.svg)](https://choosealicense.com/licenses/bsd-3-clause/) [![Repo Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![CI](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/ci.yml/badge.svg)](https://github.com/NewTec-GmbH/pyMetricCli/actions/workflows/test.yml)
 
 - [Installation](#installation)
 - [Overview](#overview)
@@ -29,6 +29,10 @@ pyMetricCli requires an adapter file to be supplied by the user. This shall cont
 
 An example adapter can be found [here](examples/adapter/adapter.py).
 
+### Deployment
+
+![deployment](https://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/NewTec-GmbH/pyMetricCli/main/doc/uml/deployment.puml)
+
 ## Usage
 
 Show help information:

doc/uml/deployment.puml

@@ -0,0 +1,78 @@
+@startuml DeploymentDiagram
+
+node "Apache Superset"<<virtual-machine>> as superset
+
+database "DB Server" {
+    component "Database" as supersetDb
+
+    note bottom of supersetDb
+        The database is project specific, means
+        one database per project.
+    end note
+
+    component "Database" as jiraDb
+}
+
+node "Polarion"<<virtual-machine>> as polarion
+database "SVN Repository" as svnRepo
+
+node "JIRA"<<virtual-machine>> as jira
+
+interface "REST API" as supersetRestApi
+interface "REST API" as jiraRestApi
+interface "SOAP API" as polarionSoapApi
+
+superset --- supersetRestApi
+jira --- jiraRestApi
+jira -- jiraDb
+polarion --- polarionSoapApi
+polarion -- svnRepo
+
+superset -- supersetDb
+
+node "Continuous Integration Server"<<virtual-machine>> {
+
+    package "scripts" {
+        component "pyJiraCli" as pyJiraCli
+        component "pyPolarionCli" as pyPolarionCli
+        component "pySupersetCli" as pySupersetCli
+        component "pyMetricCli" as pyMetricCli
+        component "pyMetricCli_Adapter" as adapter
+
+        pyJiraCli <.. pyMetricCli: <<uses>>
+        pyPolarionCli <.. pyMetricCli: <<uses>>
+        pySupersetCli <.. pyMetricCli: <<uses>>
+        pyMetricCli *--> adapter
+
+        note right of pyMetricCli
+            Called by CI cyclic to generate
+            metrics.
+        end note
+
+        note right of adapter
+            Is project specific.
+            Called by CI cyclic to generate
+            metrics.
+        end note
+    }
+}
+
+jiraRestApi )-- pyJiraCli: <<uses>>
+polarionSoapApi )-- pyPolarionCli: <<uses>>
+
+supersetRestApi )-- pySupersetCli: <<writes>>
+
+note top of superset
+    Report frontend for project metrics.
+end note
+
+note top of jira
+    Issue tracking system.
+end note
+
+note top of polarion
+    Requirements management.
+end note
+
+
+@enduml

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyMetricCli"
-version = "1.0.0"
+version = "1.0.1"
 description = "pyMetricCli is a collection of scripts and API implementations for generating and playing with metrics."
 readme = "README.md"
 requires-python = ">=3.9"