Skip to content

Commit 7eb843a

Browse files
PaebbelsPaebbels
authored
v0.29.2
2 parents 99b87a9 + 03db933 commit 7eb843a

File tree

12 files changed

+34
-217
lines changed

12 files changed

+34
-217
lines changed

‎.btd.yml‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎.github/workflows/Pipeline.yml‎

Lines changed: 3 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -8,184 +8,7 @@ on:
88
- cron: '0 22 * * 5'
99

1010
jobs:
11-
UnitTestingParams:
12-
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
11+
Pipeline:
12+
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@r2
1313
with:
14-
name: pyVHDLModel
15-
# python_version_list: "3.9 3.10 3.11 3.12 pypy-3.9 pypy-3.10"
16-
# disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
17-
18-
UnitTesting:
19-
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
20-
needs:
21-
- UnitTestingParams
22-
with:
23-
jobs: ${{ needs.UnitTestingParams.outputs.python_jobs }}
24-
requirements: "-r tests/unit/requirements.txt"
25-
pacboy: "msys/git"
26-
unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
27-
coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
28-
29-
StaticTypeCheck:
30-
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
31-
needs:
32-
- UnitTestingParams
33-
with:
34-
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
35-
commands: |
36-
mypy --html-report htmlmypy -p pyVHDLModel
37-
html_report: 'htmlmypy'
38-
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
39-
40-
DocCoverage:
41-
uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
42-
needs:
43-
- UnitTestingParams
44-
with:
45-
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
46-
directory: pyVHDLModel
47-
# fail_below: 70
48-
49-
ConfigParams:
50-
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
51-
needs:
52-
- DocCoverage
53-
54-
Package:
55-
uses: pyTooling/Actions/.github/workflows/Package.yml@dev
56-
needs:
57-
- UnitTestingParams
58-
- UnitTesting
59-
with:
60-
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
61-
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
62-
63-
PublishCoverageResults:
64-
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
65-
needs:
66-
- UnitTestingParams
67-
- UnitTesting
68-
with:
69-
# coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
70-
# coverage_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
71-
coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
72-
coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
73-
secrets:
74-
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
75-
76-
PublishTestResults:
77-
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
78-
needs:
79-
- UnitTestingParams
80-
- UnitTesting
81-
with:
82-
merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
83-
84-
# VerifyDocs:
85-
# uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
86-
# needs:
87-
# - UnitTestingParams
88-
# with:
89-
# python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
90-
91-
Documentation:
92-
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
93-
needs:
94-
- UnitTestingParams
95-
- ConfigParams
96-
- PublishTestResults
97-
- PublishCoverageResults
98-
# - VerifyDocs
99-
with:
100-
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
101-
coverage_report_json_directory: ${{ needs.ConfigParams.outputs.coverage_report_json_directory }}
102-
unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-ubuntu-native-3.12
103-
coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
104-
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
105-
latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
106-
107-
IntermediateCleanUp:
108-
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
109-
needs:
110-
- UnitTestingParams
111-
- PublishCoverageResults
112-
- PublishTestResults
113-
- Documentation
114-
with:
115-
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
116-
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
117-
118-
# PDFDocumentation:
119-
# uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
120-
# needs:
121-
# - UnitTestingParams
122-
# - Documentation
123-
# with:
124-
# document: pyVHDLModel
125-
# latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
126-
# pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
127-
128-
PublishToGitHubPages:
129-
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
130-
needs:
131-
- UnitTestingParams
132-
- Documentation
133-
# - PDFDocumentation
134-
- PublishCoverageResults
135-
- StaticTypeCheck
136-
with:
137-
doc: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
138-
# coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
139-
typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
140-
141-
ReleasePage:
142-
uses: pyTooling/Actions/.github/workflows/Release.yml@dev
143-
if: startsWith(github.ref, 'refs/tags')
144-
needs:
145-
- Package
146-
- PublishToGitHubPages
147-
148-
PublishOnPyPI:
149-
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
150-
if: startsWith(github.ref, 'refs/tags')
151-
needs:
152-
- UnitTestingParams
153-
- ReleasePage
154-
with:
155-
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
156-
requirements: -r dist/requirements.txt
157-
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
158-
secrets:
159-
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
160-
161-
ArtifactCleanUp:
162-
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
163-
needs:
164-
- UnitTestingParams
165-
- UnitTesting
166-
- StaticTypeCheck
167-
- Documentation
168-
# - PDFDocumentation
169-
- PublishTestResults
170-
- PublishCoverageResults
171-
- PublishToGitHubPages
172-
# - PublishOnPyPI
173-
with:
174-
package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
175-
remaining: |
176-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-*
177-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}-*
178-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-*
179-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}-*
180-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}-*
181-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}-*
182-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
183-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}
184-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
185-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
186-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
187-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
188-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
189-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
190-
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
191-
# ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
14+
package_name: pyVHDLModel

‎.idea/pyVHDLModel.iml‎

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
wheel ~= 0.44
1+
wheel ~= 0.45
22
twine ~= 5.1

‎doc/DataStructure/index.rst‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cross-references or dedicated data structure (tree, graph, …) for connecting m
99
Graphs
1010
******
1111

12-
pyVHDLModel uses the graph implementation from :pyTool:mod:`pyTooling.Graph` as it provides an object oriented programming
12+
pyVHDLModel uses the graph implementation from :py:mod:`pyTooling.Graph` as it provides an object oriented programming
1313
interface to vertices and edges.
1414

1515
Dependency Graph
@@ -29,7 +29,7 @@ The dependency graph describes dependencies between:
2929

3030
The relation can be:
3131

32-
* Defined in source file
32+
* defined in source file
3333
* references
3434
* implements
3535
* instantiates
@@ -41,9 +41,9 @@ Hierarchy Graph
4141

4242
The hierarchy graph can be derived from dependency graph by:
4343

44-
1. copying all entity and architecture vertices
45-
2. copying all implements dependency edges
46-
3. copying all instantiates edges in reverse direction
44+
#. copying all entity and architecture vertices
45+
#. copying all implements dependency edges
46+
#. copying all instantiates edges in reverse direction
4747

4848
The graph can then be scanned for a root vertices (no inbound edges). If only a single root vertex exists, this vertex
4949
references the toplevel of the design.
@@ -54,12 +54,13 @@ Compile Order Graph
5454

5555
The compile order can be derived from dependency graph by:
5656

57-
1. copying all document vertices
58-
2. iterating all edges in the dependency graph.
59-
1. resolve the source and the destination to the referenced design units
60-
2. resolved further to the documents these design units are declared in
61-
3. resolve further which vertices correspond in the compile order graph
62-
4. if edges does not yet exist, add an edge between two documents in the compile order graph
57+
#. copying all document vertices
58+
#. iterating all edges in the dependency graph:
59+
60+
#. resolve the source and the destination to the referenced design units
61+
#. resolved further to the documents these design units are declared in
62+
#. resolve further which vertices correspond in the compile order graph
63+
#. if edges does not yet exist, add an edge between two documents in the compile order graph
6364

6465

6566
.. toctree::

‎doc/Dependency.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pyVHDLModel Package
2323
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
2424
| **Package** | **Version** | **License** | **Dependencies** |
2525
+========================================================+=============+==========================================================================================+=================================================================================================================================+
26-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
26+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/master/LICENSE.txt>`__ | *None* |
2727
+--------------------------------------------------------+-------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
2828

2929

@@ -89,7 +89,7 @@ the mandatory dependencies too.
8989
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
9090
| **Package** | **Version** | **License** | **Dependencies** |
9191
+=================================================================================================+==============+==========================================================================================================+======================+
92-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
92+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
9393
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
9494
| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__ | ≥8.1 | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__ | *Not yet evaluated.* |
9595
+-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+
@@ -129,9 +129,9 @@ install the mandatory dependencies too.
129129
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
130130
| **Package** | **Version** | **License** | **Dependencies** |
131131
+============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
132-
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥7.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
132+
| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__ | ≥8.0 | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__ | *None* |
133133
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
134-
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.44 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
134+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.45 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
135135
+----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
136136

137137

@@ -160,7 +160,7 @@ install the mandatory dependencies too.
160160
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
161161
| **Package** | **Version** | **License** | **Dependencies** |
162162
+==========================================================+==============+===========================================================================================+======================+
163-
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.44 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
163+
| `wheel <https://GitHub.com/pypa/wheel>`__ | ≥0.45 | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__ | *Not yet evaluated.* |
164164
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+
165165
| `Twine <https://GitHub.com/pypa/twine/>`__ | ≥5.1 | `Apache License, 2.0 <https://github.com/pypa/twine/blob/main/LICENSE>`__ | *Not yet evaluated.* |
166166
+----------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------+----------------------+

0 commit comments

Comments
 (0)