v0.3.3

Paebbels · web-flow · commit 13b483d5913c · 2025-05-04T15:15:47.000+02:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -10,7 +10,6 @@ updates:
       - Dependencies
     reviewers:
       - Paebbels
-      - Umarcor
     schedule:
       interval: "daily"    # Checks on Monday trough Friday.
 
@@ -24,6 +23,5 @@ updates:
       - Dependencies
     reviewers:
       - Paebbels
-      - Umarcor
     schedule:
       interval: "weekly"
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -9,9 +9,13 @@ on:
 
 jobs:
   Pipeline:
-    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r2
+    uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev
     with:
       package_name: pySystemRDLModel
+      codecov:       true
+      codacy:        true
+      dorny:         true
     secrets:
-      PYPI_TOKEN:           ${{ secrets.PYPI_TOKEN }}
-      CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+      PYPI_TOKEN:    ${{ secrets.PYPI_TOKEN }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      CODACY_TOKEN:  ${{ secrets.CODACY_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -30,7 +30,7 @@ doc/pySystemRDLModel/**/*.*
 # BuildTheDocs
 doc/_theme/**/*.*
 
-# IntelliJ project files
+# PyCharm project files
 /.idea/workspace.xml
 
 # Git files
diff --git a/.idea/pySystemRDLModel.iml b/.idea/pySystemRDLModel.iml
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 [![PyPI](https://img.shields.io/pypi/v/pySystemRDLModel?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pySystemRDLModel/)
 ![PyPI - Status](https://img.shields.io/pypi/status/pySystemRDLModel?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pySystemRDLModel?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  
-[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/edaa-org/pySystemRDLModel/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://github.com/edaa-org/pySystemRDLModel/actions/workflows/Pipeline.yml)
+[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/actions/workflow/status/edaa-org/pySystemRDLModel/Pipeline.yml?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://github.com/edaa-org/pySystemRDLModel/actions/workflows/Pipeline.yml)
 [![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pySystemRDLModel?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pySystemRDLModel)
 [![Codacy - Quality](https://img.shields.io/codacy/grade/39d312bf98244961975559f141c3e000?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pySystemRDLModel)
 [![Codacy - Coverage](https://img.shields.io/codacy/coverage/39d312bf98244961975559f141c3e000?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pySystemRDLModel)
diff --git a/dist/requirements.txt b/dist/requirements.txt
@@ -1,2 +1,2 @@
 wheel ~= 0.45
-twine ~= 5.1
+twine ~= 6.1
diff --git a/doc/CodeCoverage.rst b/doc/CodeCoverage.rst
@@ -0,0 +1,25 @@
+.. _CODECOV:
+
+Code Coverage Report
+####################
+
+.. grid:: 2
+
+   .. grid-item::
+      :columns: 8
+
+      .. report:code-coverage::
+         :reportid: src
+
+   .. grid-item::
+      :columns: 4
+
+      .. report:code-coverage-legend::
+         :reportid: src
+         :style: vertical-table
+
+----------
+
+Code coverage report generated with `pytest <https://github.com/pytest-dev/pytest>`__,
+`Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__ and visualized by
+`sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.
diff --git a/doc/Dependency.rst b/doc/Dependency.rst
diff --git a/doc/DocCoverage.rst b/doc/DocCoverage.rst
@@ -1,7 +1,24 @@
-Documentation Coverage
-######################
+.. _DOCCOV:
 
-Documentation coverage generated by `docstr-coverage <https://github.com/HunterMcGushion/docstr_coverage>`__.
+Documentation Coverage Report
+#############################
 
-.. report:doc-coverage::
-   :packageid: src
+.. grid:: 2
+
+   .. grid-item::
+      :columns: 5
+
+      .. report:doc-coverage::
+         :reportid: src
+
+   .. grid-item::
+      :columns: 7
+
+      .. report:doc-coverage-legend::
+         :reportid: src
+         :style: vertical-table
+
+----------
+
+Documentation coverage generated with `"""docstr-coverage""" <https://github.com/HunterMcGushion/docstr_coverage>`__ and
+visualized by `sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.
diff --git a/doc/Installation.rst b/doc/Installation.rst
@@ -28,8 +28,10 @@ PIP might download further packages as listed in :ref:`package dependencies <DEP
 Installing a Wheel Package from PyPI using PIP
 ==============================================
 
-Developers can install further dependencies for documentation generation (``doc``) or running unit tests (``test``) or
-just all (``all``) dependencies.
+Developers can install the |PackageName| package itself or the package with further dependencies for documentation
+generation (``doc``), running unit tests (``test``) or just all (``all``) dependencies.
+
+See :ref:`DEP` for more details.
 
 .. tab-set::
 
diff --git a/doc/conf.py b/doc/conf.py
@@ -7,11 +7,21 @@
 
 from pyTooling.Packaging import extractVersionInformation
 
+# ==============================================================================
+# Project configuration
+# ==============================================================================
+githubNamespace = "edaa-org"
+project = "pySystemRDLModel"
+directoryName = project.replace('.', '/')
+
+# ==============================================================================
+# Project paths
+# ==============================================================================
 ROOT = Path(__file__).resolve().parent
 
 sys_path.insert(0, abspath("."))
 sys_path.insert(0, abspath(".."))
-sys_path.insert(0, abspath("../pySystemRDLModel"))
+sys_path.insert(0, abspath(f"../{directoryName}"))
 
 
 # ==============================================================================
@@ -20,10 +30,7 @@
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-githubNamespace = "edaa-org"
-project = "pySystemRDLModel"
-
-packageInformationFile = Path(f"../{project.replace('.', '/')}/__init__.py")
+packageInformationFile = Path(f"../{directoryName}/__init__.py")
 versionInformation = extractVersionInformation(packageInformationFile)
 
 author =    versionInformation.Author
@@ -206,11 +213,12 @@
 # Sphinx.Ext.ExtLinks
 # ==============================================================================
 extlinks = {
-	"gh":      (f"https://github.com/%s", "gh:%s"),
-	"ghissue": (f"https://github.com/{githubNamespace}/{project}/issues/%s", "issue #%s"),
-	"ghpull":  (f"https://github.com/{githubNamespace}/{project}/pull/%s", "pull request #%s"),
-	"ghsrc":   (f"https://github.com/{githubNamespace}/{project}/blob/main/%s", None),
-	"wiki":    (f"https://en.wikipedia.org/wiki/%s", None),
+	"gh":          (f"https://github.com/%s", "%s"),
+	"ghissue":     (f"https://github.com/{githubNamespace}/{project}/issues/%s", "issue #%s"),
+	"ghpull":      (f"https://github.com/{githubNamespace}/{project}/pull/%s", "pull request #%s"),
+	"ghsrc":       (f"https://github.com/{githubNamespace}/{project}/blob/main/%s", None),
+	"pypi":        ( "https://PyPI.org/project/%s", "%s"),
+	"wiki":        (f"https://en.wikipedia.org/wiki/%s", None),
 }
 
 
@@ -255,7 +263,7 @@
 report_unittest_testsuites = {
 	"src": {
 		"name":        f"{project}",
-		"xml_report":  "../report/unit/TestReportSummary.xml",
+		"xml_report":  "../report/unit/unittest.xml",
 	}
 }
 report_codecov_packages = {
@@ -269,7 +277,7 @@
 report_doccov_packages = {
 	"src": {
 		"name":       f"{project}",
-		"directory":  f"../{project}",
+		"directory":  f"../{directoryName}",
 		"fail_below": 80,
 		"levels":     "default"
 	}
diff --git a/doc/coverage/index.rst b/doc/coverage/index.rst
@@ -1,8 +1,7 @@
-Code Coverage Report
-####################
+Code Coverage Details
+#####################
 
 Code coverage report generated with `pytest <https://github.com/pytest-dev/pytest>`__ and `Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__.
 
-
 .. report:code-coverage::
-   :packageid: src
+   :reportid: src
diff --git a/doc/index.rst b/doc/index.rst
@@ -35,7 +35,7 @@ The pySystemRDLModel Documentation
 An abstract SystemRDL language model.
 
 
-.. _goals:
+.. _GOALS:
 
 Main Goals
 **********
@@ -48,15 +48,15 @@ Projects consuming pre-processed SystemRDL data (parsed, analyzed or elaborated)
 and services on such a model, while supporting multiple frontends.
 
 
-.. _usecase:
+.. _USECASES:
 
 Use Cases
 *********
 
 * TBD
 
 
-.. _news:
+.. _NEWS:
 
 News
 ****
@@ -78,7 +78,7 @@ News
 Contributors
 ************
 
-* `Patrick Lehmann <https://github.com/Paebbels>`__ (Maintainer)
+* :gh:`Patrick Lehmann <Paebbels>` (Maintainer)
 * `and more... <https://github.com/edaa-org/pySystemRDLModel/graphs/contributors>`__
 
 
@@ -129,9 +129,10 @@ License
    :caption: References and Reports
    :hidden:
 
-   pySystemRDLModel/pySystemRDLModel
+   Python Class Reference <pySystemRDLModel/pySystemRDLModel>
    unittests/index
    coverage/index
+   CodeCoverage
    Doc. Coverage Report <DocCoverage>
    Static Type Check Report ➚ <typing/index>
 
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,19 +1,17 @@
 -r ../requirements.txt
 
 # Enforce latest version on ReadTheDocs
-sphinx ~= 8.1
+sphinx ~= 8.2
 docutils ~= 0.21
 docutils_stubs ~= 0.0.22
 
 # ReadTheDocs Theme
-sphinx_rtd_theme ~= 3.0.0
+sphinx_rtd_theme ~= 3.0
 
 # Sphinx Extenstions
 sphinxcontrib-mermaid ~= 1.0
 autoapi >= 2.0.1
 sphinx_design ~= 0.6.1
 sphinx-copybutton >= 0.5.2
-sphinx_autodoc_typehints ~= 2.5
-sphinx_reports ~= 0.7
-
-# BuildTheDocs Extensions (mostly patched Sphinx extensions)
+sphinx_autodoc_typehints ~= 3.2
+sphinx_reports ~= 0.9
diff --git a/doc/shields.inc b/doc/shields.inc
@@ -64,11 +64,11 @@
    :target: https://github.com/edaa-org/pySystemRDLModel/network/dependents
 
 .. # GHA test and coverage
-.. |SHIELD:svg:pySystemRDLModel-gha-test| image:: https://img.shields.io/github/workflow/status/edaa-org/pySystemRDLModel/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF
+.. |SHIELD:svg:pySystemRDLModel-gha-test| image:: https://img.shields.io/github/actions/workflow/status/edaa-org/pySystemRDLModel/Pipeline.yml?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF
    :alt: GitHub Workflow - Build and Test Status
    :height: 22
    :target: https://github.com/edaa-org/pySystemRDLModel/actions/workflows/Pipeline.yml
-.. |SHIELD:png:pySystemRDLModel-gha-test| image:: https://raster.shields.io/github/workflow/status/edaa-org/pySystemRDLModel/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF
+.. |SHIELD:png:pySystemRDLModel-gha-test| image:: https://raster.shields.io/github/actions/workflow/status/edaa-org/pySystemRDLModel/Pipeline.yml?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF
    :alt: GitHub Workflow - Build and Test Status
    :height: 22
    :target: https://github.com/edaa-org/pySystemRDLModel/actions/workflows/Pipeline.yml
diff --git a/doc/unittests/index.rst b/doc/unittests/index.rst
@@ -1,7 +1,12 @@
 Unittest Summary Report
 #######################
 
-Unittest report generated with `pytest <https://github.com/pytest-dev/pytest>`__.
-
 .. report:unittest-summary::
    :reportid: src
+   :show-testcases: not-passed
+   :no-assertions:
+
+----------
+
+Unittest report generated with `pytest <https://github.com/pytest-dev/pytest>`__ and visualized by
+`sphinx-reports <https://github.com/pyTooling/sphinx-reports>`__.
diff --git a/pySystemRDLModel/__init__.py b/pySystemRDLModel/__init__.py
@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2023-2024 Patrick Lehmann - Boetzingen, Germany                                                            #
+# Copyright 2023-2025 Patrick Lehmann - Boetzingen, Germany                                                            #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -39,7 +39,7 @@
 
 .. admonition:: Copyright Information
 
-   :copyright: Copyright 2023-2024 Patrick Lehmann - Bötzingen, Germany
+   :copyright: Copyright 2023-2025 Patrick Lehmann - Bötzingen, Germany
    :license: Apache License, Version 2.0
 """
 from enum   import unique, Enum
@@ -50,9 +50,9 @@
 
 __author__ =    "Patrick Lehmann"
 __email__ =     "Paebbels@gmail.com"
-__copyright__ = "2023-2024, Patrick Lehmann"
+__copyright__ = "2023-2025, Patrick Lehmann"
 __license__ =   "Apache License, Version 2.0"
-__version__ =   "0.3.2"
+__version__ =   "0.3.3"
 
 
 @export
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,8 @@
 [build-system]
 requires = [
-  "setuptools ~= 75.4",
+  "setuptools >= 80.0",
   "wheel ~= 0.45",
-  "pyTooling ~= 8.0"
+  "pyTooling ~= 8.4"
 ]
 build-backend = "setuptools.build_meta"
 
@@ -20,6 +20,12 @@ show_error_codes = true
 namespace_packages = true
 html_report = "report/typing"
 
+[tool.pytest]
+junit_xml = "report/unit/UnittestReportSummary.xml"
+
+[tool.pyedaa-reports]
+junit_xml = "report/unit/unittest.xml"
+
 [tool.pytest.ini_options]
 addopts = "--tb=native"
 # Don't set 'python_classes = *' otherwise, pytest doesn't search for classes
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1 @@
-pyTooling ~= 8.0
+pyTooling ~= 8.4
diff --git a/run.ps1 b/run.ps1
diff --git a/setup.py b/setup.py
diff --git a/tests/requirements.txt b/tests/requirements.txt
diff --git a/tests/unit/Instantiate.py b/tests/unit/Instantiate.py
diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`wheel ~= 0.45`
`2`		`-twine ~= 5.1`
	`2`	`+twine ~= 6.1`