General updates.

edaa-org · Feb 21, 2025 · 9648a2e · 9648a2e
1 parent c34795e
commit 9648a2e
Show file tree

Hide file tree

Showing 24 changed files with 81 additions and 49 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,13 @@ __pycache__/
 .coverage
 .cov
 coverage.xml
+/report/coverage
+
+# mypy
+/report/typing
+
+# pytest
+/report/unit
 
 # setuptools
 /build/**/*.*
@@ -21,5 +28,8 @@ coverage.xml
 /doc/pyEDAA.UCIS/**/*.*
 !/doc/pyEDAA.UCIS/index.rst
 
-# PyCharm project
+# PyCharm project files
 /.idea/workspace.xml
+
+# Git files
+!.git*
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 [![PyPI](https://img.shields.io/pypi/v/pyEDAA.UCIS?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pyEDAA.UCIS/)
 ![PyPI - Status](https://img.shields.io/pypi/status/pyEDAA.UCIS?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyEDAA.UCIS?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  
-[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/edaa-org/pyEDAA.UCIS/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://github.com/edaa-org/pyEDAA.UCIS/actions/workflows/Pipeline.yml)
+[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/actions/workflow/status/edaa-org/pyEDAA.UCIS/Pipeline.yml?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://github.com/edaa-org/pyEDAA.UCIS/actions/workflows/Pipeline.yml)
 [![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyEDAA.UCIS?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pyEDAA.UCIS)
 [![Codacy - Quality](https://img.shields.io/codacy/grade/63bd2bd65585447a9f6d7ad4e7d82a35?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.UCIS)
 [![Codacy - Coverage](https://img.shields.io/codacy/coverage/63bd2bd65585447a9f6d7ad4e7d82a35?longCache=true&style=flat-square&logo=Codacy)](https://app.codacy.com/gh/edaa-org/pyEDAA.UCIS)

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/DocCoverage.rst b/doc/DocCoverage.rst
@@ -0,0 +1,7 @@
+Documentation Coverage
+######################
+
+Documentation coverage generated by `docstr-coverage <https://github.com/HunterMcGushion/docstr_coverage>`__.
+
+.. report:doc-coverage::
+   :packageid: src
diff --git a/doc/TODO.rst b/doc/TODO.rst
@@ -0,0 +1,4 @@
+TODOs
+#####
+
+.. todolist::
diff --git a/doc/coverage/index.rst b/doc/coverage/index.rst
@@ -1,4 +1,7 @@
-Coverage Report
-###############
+Code Coverage Report
+####################
 
-*Placeholder for the Coverage report generated with* ``pytest`` *and* ``coverage``.
+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
diff --git a/doc/genindex.rst b/doc/genindex.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -104,10 +104,10 @@ News
 Contributors
 ************
 
-* `Patrick Lehmann <https://github.com/Paebbels>`__ (Maintainer)
+* :gh:`Patrick Lehmann <Paebbels>` (Maintainer)
 * `Artur Porebski (Aldec Inc.) <https://github.com/por3bski>`__
 * `Michal Pacula (Aldec Inc.) <https://github.com/mikep996>`__
-* `Unai Martinez-Corral <https://github.com/umarcor/>`__
+* :gh:`Unai Martinez-Corral <umarcor>`
 * `and more... <https://github.com/edaa-org/pyEDAA.UCIS/graphs/contributors>`__
 
 
@@ -151,14 +151,19 @@ License
 
 .. raw:: latex
 
-   \part{References}
+   \part{References and Reports}
 
 .. toctree::
-   :caption: References
+   :caption: References and Reports
    :hidden:
 
-   CommandLineInterface
-   pyEDAA.UCIS/index
+   Python Class Reference <pyEDAA.UCIS/pyEDAA.UCIS>
+   unittests/index
+   coverage/index
+   Doc. Coverage Report <DocCoverage>
+   Static Type Check Report ➚ <typing/index>
+
+.. Coverage Report ➚ <coverage/index>
 
 .. raw:: latex
 
@@ -168,12 +173,9 @@ License
    :caption: Appendix
    :hidden:
 
-   Coverage Report ➚ <coverage/index>
-   Static Type Check Report ➚ <typing/index>
    License
    Doc-License
    Glossary
    genindex
-
-.. #
-   py-modindex
+   Python Module Index <modindex>
+   TODO
diff --git a/doc/py-modindex.rst b/doc/py-modindex.rst
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_autodoc_typehints ~= 3.1
 sphinx_reports ~= 0.7
-
-# BuildTheDocs Extensions (mostly patched Sphinx extensions)
diff --git a/doc/shields.inc b/doc/shields.inc
@@ -64,11 +64,11 @@
    :target: https://github.com/edaa-org/pyEDAA.UCIS/network/dependents
 
 .. # GHA test and coverage
-.. |SHIELD:svg:UCIS-gha-test| image:: https://img.shields.io/github/workflow/status/edaa-org/pyEDAA.UCIS/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF
+.. |SHIELD:svg:UCIS-gha-test| image:: https://img.shields.io/github/actions/workflow/status/edaa-org/pyEDAA.UCIS/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/pyEDAA.UCIS/actions/workflows/Pipeline.yml
-.. |SHIELD:png:UCIS-gha-test| image:: https://raster.shields.io/github/workflow/status/edaa-org/pyEDAA.UCIS/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20Test&logo=GitHub%20Actions&logoColor=FFFFFF
+.. |SHIELD:png:UCIS-gha-test| image:: https://raster.shields.io/github/actions/workflow/status/edaa-org/pyEDAA.UCIS/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/pyEDAA.UCIS/actions/workflows/Pipeline.yml

diff --git a/doc/unittests/index.rst b/doc/unittests/index.rst
@@ -0,0 +1,7 @@
+Unittest Summary Report
+#######################
+
+Unittest report generated with `pytest <https://github.com/pytest-dev/pytest>`__.
+
+.. report:unittest-summary::
+   :reportid: src
diff --git a/pyEDAA/UCIS/CLI/__init__.py b/pyEDAA/UCIS/CLI/__init__.py
@@ -13,7 +13,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/pyEDAA/UCIS/Cobertura.py b/pyEDAA/UCIS/Cobertura.py
@@ -12,7 +12,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/pyEDAA/UCIS/UCDB.py b/pyEDAA/UCIS/UCDB.py
@@ -12,7 +12,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/pyEDAA/UCIS/__init__.py b/pyEDAA/UCIS/__init__.py
@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -31,7 +31,7 @@
 """The Unified Coverage Interoperability Standard (UCIS) layer of EDA² offers a data model for reading UCDB files."""
 __author__ =    "Patrick Lehmann"
 __email__ =     "Paebbels@gmail.com"
-__copyright__ = "2021-2024, Electronic Design Automation Abstraction (EDA²)"
+__copyright__ = "2021-2025, Electronic Design Automation Abstraction (EDA²)"
 __license__ =   "Apache License, Version 2.0"
 __version__ =   "0.3.0"
 __keywords__ =  ["UCIS", "UCDB", "coverage", "Cobertura", "xml"]
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,8 @@
 [build-system]
 requires = [
-  "setuptools ~= 75.3",
+  "setuptools ~= 75.8",
   "wheel ~= 0.45",
-  "pyTooling ~= 8.0"
+  "pyTooling ~= 8.1"
 ]
 build-backend = "setuptools.build_meta"
 
@@ -20,6 +20,9 @@ show_error_codes = true
 namespace_packages = true
 html_report = "report/typing"
 
+[tool.pytest]
+junit_xml = "report/unit/TestReportSummary.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,2 +1,2 @@
-pyTooling ~= 8.0
+pyTooling ~= 8.1
 lxml ~= 5.3
diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #
@@ -29,24 +29,29 @@
 # ==================================================================================================================== #
 #
 """Package installer for 'Tools to extract and convert data from UCDB files'."""
+from setuptools          import setup
+
 from pathlib             import Path
-from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub
+from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub, DEFAULT_CLASSIFIERS
 
 gitHubNamespace =        "pyEDAA"
 packageName =            "pyEDAA.UCIS"
 packageDirectory =       packageName.replace(".", "/")
 packageInformationFile = Path(f"{packageDirectory}/__init__.py")
 
-DescribePythonPackageHostedOnGitHub(
+setup(**DescribePythonPackageHostedOnGitHub(
 	packageName=packageName,
 	description="Tools to extract and convert data from UCDB files.",
 	gitHubNamespace=gitHubNamespace,
 	sourceFileWithVersion=packageInformationFile,
 	developmentStatus="stable",
-	classifiers=[
+	classifiers=list(DEFAULT_CLASSIFIERS) + [
 		"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
 	],
+	dataFiles={
+		packageName: ["py.typed"]
+	},
 	consoleScripts={
 		"pyedaa-ucis": "pyEDAA.UCIS.CLI:main"
 	}
-)
+))
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -8,7 +8,7 @@ pytest ~= 8.3
 pytest-cov ~= 6.0
 
 # Static Type Checking
-mypy ~= 1.13
+mypy ~= 1.15
 typing_extensions ~= 4.12
 lxml ~= 5.3
 

diff --git a/tests/unit/CLI.py b/tests/unit/CLI.py
@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/tests/unit/UCDB.py b/tests/unit/UCDB.py
@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py
@@ -11,7 +11,7 @@
 #                                                                                                                      #
 # License:                                                                                                             #
 # ==================================================================================================================== #
-# Copyright 2021-2024 Electronic Design Automation Abstraction (EDA²)                                                  #
+# Copyright 2021-2025 Electronic Design Automation Abstraction (EDA²)                                                  #
 #                                                                                                                      #
 # Licensed under the Apache License, Version 2.0 (the "License");                                                      #
 # you may not use this file except in compliance with the License.                                                     #

diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt
@@ -0,0 +1 @@
+-r ../requirements.txt