v0.4.1

edaa-org · Dec 27, 2021 · 13857e4 · 13857e4
2 parents 736a5dd + f5b50f3
commit 13857e4
Show file tree

Hide file tree

Showing 41 changed files with 882 additions and 769 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,8 +1,11 @@
 # New Features
+
 * tbd
 
 # Changes
+
 * tbd
 
 # Bug Fixes
+
 * tbd
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -3,10 +3,8 @@ name: Pipeline
 on:
   push:
   workflow_dispatch:
-
-defaults:
-  run:
-    shell: bash
+  schedule:
+    - cron: '0 0 * * 5'
 
 jobs:
 
@@ -119,6 +117,7 @@ jobs:
       - StaticTypeCheck
       - BuildTheDocs
       - PublishToGitHubPages
+      - PublishTestResults
     with:
       package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
       remaining: |

diff --git a/.gitignore b/.gitignore
@@ -16,12 +16,10 @@ coverage.xml
 !requirements.txt
 
 # Sphinx
-doc/_build/
-doc/pyEDAA.ProjectModel/**/*.*
-!doc/pyEDAA.ProjectModel/index.rst
+/doc/_build/
+/doc/_theme/
+/doc/pyEDAA.ProjectModel/**/*.*
+!/doc/pyEDAA.ProjectModel/index.rst
 
-# BuildTheDocs
-doc/_theme/**/*.*
-
-# IntelliJ project files
+# PyCharm project files
 /.idea/workspace.xml
diff --git a/.idea/pyEDAA.ProjectModel.iml b/.idea/pyEDAA.ProjectModel.iml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+"files.trimTrailingWhitespace": false,
+}
diff --git a/README.md b/README.md
@@ -12,8 +12,8 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyEDAA.ProjectModel?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.ProjectModel/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/edaa-org/pyEDAA.ProjectModel/actions/workflows/Pipeline.yml)
 [![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyEDAA.ProjectModel?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/edaa-org/pyEDAA.ProjectModel)
-[![Codacy - Quality](https://img.shields.io/codacy/grade/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/manual/edaa-org/pyEDAA.ProjectModel)
-[![Codacy - Coverage](https://img.shields.io/codacy/coverage/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/manual/edaa-org/pyEDAA.ProjectModel)
+[![Codacy - Quality](https://img.shields.io/codacy/grade/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/gh/edaa-org/pyEDAA.ProjectModel)
+[![Codacy - Coverage](https://img.shields.io/codacy/coverage/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/gh/edaa-org/pyEDAA.ProjectModel)
 [![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/edaa-org/pyEDAA.ProjectModel?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/edaa-org/pyEDAA.ProjectModel)
 
 <!--
@@ -31,7 +31,7 @@ a concrete project model for their tools.
 Frameworks consuming this model can build higher level features and services on top of
 such a model, while supporting multiple input sources.
 
-## Data Model
+# Data Model
 
 1. The toplevel element is a `Project`, which contains one or multiple designs.
 2. A `Design` is a variant of a project and contains filesets.
@@ -41,37 +41,39 @@ such a model, while supporting multiple input sources.
 
 ![img.png](doc/datamodel.png)
 
-## Features
+# Features
 
 * Construct a project model:  
   * top-down (project &rarr; design &rarr; fileset &rarr; file) or
   * bottom-up (file &rarr; fileset &rarr; design &rarr; project) or
   * parsing a project file.
+
 * Designs, filesets and files can use absolute or relative paths.
   * `ResolvedPath` returns the resolved absolute path to an object.
+
 * Projects, designs, filesets and files can be validated (e.g. if the path exists).
+
 * Projects, designs, filesets and files can have user-defined attributes.
   * User-defined attributes are resolved bottom-up.
 
+# Project File Readers
 
-## Project File Readers
-
-### OSVVM `*.pro` File Reader
+## OSVVM `*.pro` File Reader
 
 ProjectModel can read `*.pro` files and extract source files. Included `*.pro` files
 are represented as sub-filesets.
 
-### Xilinx Vivado `*.xpr` Reader
+## Xilinx Vivado `*.xpr` Reader
 
 ProjectModel can read `*.xpr` files and extract source, constraint and simulation
 files while preserving the fileset structure.
 
-## Use Cases
+# Use Cases
+
 * Reading OSVVM's `*.pro` files.
 * Reading Xilinx Vivado's `*.xpr` files.
 
-
-## Examples
+# Examples
 
 ```python
 from pathlib import Path
@@ -96,28 +98,25 @@ for file in designA.Files(fileType=VHDLSourceFile):
 	print(f"  {file.Path}")
 ```
 
-
 # References
 
-- [Paebbels/pyIPCMI: pyIPCMI/Base/Project.py](https://GitHub.com/Paebbels/pyIPCMI/blob/master/pyIPCMI/Base/Project.py)
-- [VUnit/vunit: vunit/project.py](https://GitHub.com/VUnit/vunit/blob/master/vunit/project.py)
-- [PyFPGA/pyfpga: fpga/project.py](https://GitHub.com/PyFPGA/pyfpga/blob/main/fpga/project.py)
-- [olofk/fusesoc: fusesoc/capi2/core.py](https://GitHub.com/olofk/fusesoc/blob/master/fusesoc/capi2/core.py)
-- [XedaHQ/xeda: xeda/flows/flow.py](https://GitHub.com/XedaHQ/xeda/blob/master/xeda/flows/flow.py)
-- [tsfpga/tsfpga: tsfpga/build_project_list.py](https://gitlab.com/tsfpga/tsfpga/-/blob/master/tsfpga/build_project_list.py)
-- [hdl-make: hdlmake/](https://ohwr.org/project/hdl-make/tree/master/hdlmake)
-- [OSVVM/OSVVM-Scripts: OsvvmProjectScripts.tcl](https://GitHub.com/OSVVM/OSVVM-Scripts/blob/master/OsvvmProjectScripts.tcl)
+* [Paebbels/pyIPCMI: pyIPCMI/Base/Project.py](https://GitHub.com/Paebbels/pyIPCMI/blob/master/pyIPCMI/Base/Project.py)
+* [VUnit/vunit: vunit/project.py](https://GitHub.com/VUnit/vunit/blob/master/vunit/project.py)
+* [PyFPGA/pyfpga: fpga/project.py](https://GitHub.com/PyFPGA/pyfpga/blob/main/fpga/project.py)
+* [olofk/fusesoc: fusesoc/capi2/core.py](https://GitHub.com/olofk/fusesoc/blob/master/fusesoc/capi2/core.py)
+* [XedaHQ/xeda: xeda/flows/flow.py](https://GitHub.com/XedaHQ/xeda/blob/master/xeda/flows/flow.py)
+* [tsfpga/tsfpga: tsfpga/build_project_list.py](https://gitlab.com/tsfpga/tsfpga/-/blob/master/tsfpga/build_project_list.py)
+* [hdl-make: hdlmake/](https://ohwr.org/project/hdl-make/tree/master/hdlmake)
+* [OSVVM/OSVVM-Scripts: OsvvmProjectScripts.tcl](https://GitHub.com/OSVVM/OSVVM-Scripts/blob/master/OsvvmProjectScripts.tcl)
 
+# Contributors
 
-
-## Contributors
 * [Patrick Lehmann](https://GitHub.com/Paebbels) (Maintainer)
 * [Unai Martinez-Corral](https://GitHub.com/umarcor)
 * [Stefan Unrein](https://GitHub.com/stefanunrein)
 * [and more...](https://GitHub.com/edaa-org/pyEDAA.ProjectModel/graphs/contributors)
 
-
-## License
+# License
 
 This Python package (source code) licensed under [Apache License 2.0](LICENSE.md).  
 The accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst).

diff --git a/doc/Dependency.rst b/doc/Dependency.rst
@@ -27,7 +27,7 @@ pyEDAA.ProjectModel Package
 +----------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                              | **Version** | **License**                                                                               | **Dependencies**                                                                                                                |
 +==========================================================+=============+===========================================================================================+=================================================================================================================================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__   | ≥1.7.0      | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__    | *None*                                                                                                                          |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__   | ≥1.8.1      | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__    | *None*                                                                                                                          |
 +----------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
 | `pyVHDLModel <https://GitHub.com/VHDL/pyVHDLModel>`__    | ≥0.13.0     | `Apache License, 2.0 <https://GitHub.com/VHDL/pyVHDLModel/blob/master/LICENSE>`__         |                                                                                                                                 |
 +----------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
@@ -65,7 +65,7 @@ the mandatory dependencies too.
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | `Coverage <https://GitHub.com/nedbat/coveragepy>`__       | ≥6.2        | `Apache License, 2.0 <https://GitHub.com/nedbat/coveragepy/blob/master/LICENSE.txt>`__ | *Not yet evaluated.* |
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
-| `mypy <https://GitHub.com/python/mypy>`__                 | ≥0.910      | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__                           | *Not yet evaluated.* |
+| `mypy <https://GitHub.com/python/mypy>`__                 | ≥0.930      | `MIT <https://GitHub.com/python/mypy/blob/master/LICENSE>`__                           | *Not yet evaluated.* |
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
 | `lxml <https://GitHub.com/lxml/lxml>`__                   | ≥4.6.4      | `BSD 3-Clause <https://GitHub.com/lxml/lxml/blob/master/LICENSE.txt>`__                | *Not yet evaluated.* |
 +-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+
@@ -95,7 +95,7 @@ the mandatory dependencies too.
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                                                                     | **Version**  | **License**                                                                                              | **Dependencies**                                                                                                                                     |
 +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling.Packaging <https://GitHub.com/pyTooling/pyTooling>`__                                | ≥1.7.0       | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling.Packaging/blob/main/LICENSE.md>`__          | *None*                                                                                                                                               |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                                          | ≥1.8.1       | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥4.3.0       | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -131,7 +131,7 @@ install the mandatory dependencies too.
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                                                | **Version**  | **License**                                                                                              | **Dependencies**                                                                                                                                     |
 +============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling.Packaging <https://GitHub.com/pyTooling/pyTooling>`__           | ≥1.7.0       | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling.Packaging/blob/main/LICENSE.md>`__          | *None*                                                                                                                                               |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                     | ≥1.8.1       | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `wheel <https://GitHub.com/pypa/wheel>`__                                  | any          | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__                                            | *Not yet evaluated.*                                                                                                                                 |
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

diff --git a/doc/Makefile b/doc/Makefile
@@ -1,6 +1,3 @@
-CP=cp
-
-# Sphinx options.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
@@ -10,19 +7,5 @@ PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-all: html latex
-
-#---
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-
-#---
-
-html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-
-#---
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+%:
+	$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) $(BUILDDIR)/$@
diff --git a/doc/index.rst b/doc/index.rst
@@ -175,9 +175,8 @@ License
    :caption: Appendix
    :hidden:
 
-   coverage/index
-   typing/index
-   ChangeLog/index
+   Coverage Report ➚ <https://edaa-org.GitHub.io/pyEDAA.ProjectModel/coverage/>
+   Static Type Check Report ➚ <https://edaa-org.GitHub.io/pyEDAA.ProjectModel/typing/>
    License
    Doc-License
    Glossary

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,6 +1,6 @@
 -r ../requirements.txt
 
-pyTooling>=1.7.0
+pyTooling>=1.8.1
 
 # Enforce latest version on ReadTheDocs
 sphinx>=4.3.0

diff --git a/doc/shields.inc b/doc/shields.inc
@@ -67,21 +67,21 @@
 .. |SHIELD:svg:ProjectModel-codacy-quality| image:: https://img.shields.io/codacy/grade/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=codacy
    :alt: Codacy - Quality
    :height: 22
-   :target: https://www.codacy.com/manual/edaa-org/pyEDAA.ProjectModel
+   :target: https://www.codacy.com/gh/edaa-org/pyEDAA.ProjectModel
 .. |SHIELD:png:ProjectModel-codacy-quality| image:: https://raster.shields.io/codacy/grade/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=codacy
    :alt: Codacy - Quality
    :height: 22
-   :target: https://www.codacy.com/manual/edaa-org/pyEDAA.ProjectModel
+   :target: https://www.codacy.com/gh/edaa-org/pyEDAA.ProjectModel
 
 .. # Codacy - coverage
 .. |SHIELD:svg:ProjectModel-codacy-coverage| image:: https://img.shields.io/codacy/coverage/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=codacy
    :alt: Codacy - Line Coverage
    :height: 22
-   :target: https://www.codacy.com/manual/edaa-org/pyEDAA.ProjectModel
+   :target: https://www.codacy.com/gh/edaa-org/pyEDAA.ProjectModel
 .. |SHIELD:png:ProjectModel-codacy-coverage| image:: https://raster.shields.io/codacy/coverage/c2635df20fa840bc85639ca2fa1d9cb4?longCache=true&style=flat-square&logo=codacy
    :alt: Codacy - Line Coverage
    :height: 22
-   :target: https://www.codacy.com/manual/edaa-org/pyEDAA.ProjectModel
+   :target: https://www.codacy.com/gh/edaa-org/pyEDAA.ProjectModel
 
 .. # Codecov - coverage
 .. |SHIELD:svg:ProjectModel-codecov-coverage| image:: https://img.shields.io/codecov/c/github/edaa-org/pyEDAA.ProjectModel?longCache=true&style=flat-square&logo=Codecov
@@ -169,7 +169,7 @@
    :height: 22
    :target: https://edaa-org.github.io/pyEDAA.ProjectModel/
 
-.. # Gitter 
+.. # Gitter
 .. |SHIELD:svg:ProjectModel-gitter| image:: https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef
    :alt: Documentation License
    :height: 22