v0.1.0

edaa-org · Feb 21, 2024 · 944dddb · 944dddb
2 parents 31507ea + c09dc8e
commit 944dddb
Show file tree

Hide file tree

Showing 57 changed files with 9,592 additions and 510 deletions.
diff --git a/.btd.yml b/.btd.yml
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,30 @@
+root = true
+
+[*]
+charset = utf-8
+# end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 2
+tab_width = 2
+
+
+[*.py]
+indent_style = tab
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{json,ini}]
+indent_style = tab
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.rst]
+indent_style = space
+indent_size = 3
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,27 @@
+version: 2
+updates:
+  # Maintain Python packages
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: dev
+    commit-message:
+      prefix: "[Dependabot]"
+    labels:
+      - Dependencies
+    reviewers:
+      - Paebbels
+    schedule:
+      interval: "daily"    # Checks on Monday trough Friday.
+
+  # Maintain GitHub Action runners
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: dev
+    commit-message:
+      prefix: "[Dependabot]"
+    labels:
+      - Dependencies
+    reviewers:
+      - Paebbels
+    schedule:
+      interval: "weekly"
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,5 +1,5 @@
 # New Features
-
+ 
 * tbd
 
 # Changes
@@ -9,3 +9,8 @@
 # Bug Fixes
 
 * tbd
+
+----------
+# Related PRs:
+
+* tbd
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -4,38 +4,183 @@ on:
   push:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 5'
+# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
+    - cron: '0 22 * * 5'
 
 jobs:
-
-  Params:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r0
+  UnitTestingParams:
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r1
     with:
       name: pyEDAA.Reports
+      python_version_list: "3.8 3.9 3.10 3.11 3.12 pypy-3.8 pypy-3.9 pypy-3.10"
+#      disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
 
-  BuildTheDocs:
-    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@r0
+  UnitTesting:
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r1
     needs:
-      - Params
+      - UnitTestingParams
     with:
-      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+      jobs: ${{ needs.UnitTestingParams.outputs.python_jobs }}
+      requirements: "-r tests/unit/requirements.txt"
+      pacboy: "msys/git"
+      unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
 
-  PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r0
+  StaticTypeCheck:
+    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r1
+    needs:
+      - UnitTestingParams
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      commands: |
+        touch pyEDAA/__init__.py
+        mypy --html-report htmlmypy -p pyEDAA.Reports
+      html_report: 'htmlmypy'
+      html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
+
+  DocCoverage:
+    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r1
+    needs:
+      - UnitTestingParams
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      directory: sphinx_reports
+#      fail_below: 70
+
+  Package:
+    uses: pyTooling/Actions/.github/workflows/Package.yml@r1
+    needs:
+      - UnitTestingParams
+      - UnitTesting
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+
+  PublishCoverageResults:
+    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r1
+    needs:
+      - UnitTestingParams
+      - UnitTesting
+    with:
+#      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
+#      coverage_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
+      coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+      coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
+    secrets:
+      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+
+  PublishTestResults:
+    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r1
+    needs:
+      - UnitTestingParams
+      - UnitTesting
+    with:
+      merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+
+  IntermediateCleanUp:
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r1
+    needs:
+      - UnitTestingParams
+      - PublishCoverageResults
+      - PublishTestResults
+      - HTMLDocumentation
+    with:
+      sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
+      xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
+
+#  VerifyDocs:
+#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@r1
+#    needs:
+#      - UnitTestingParams
+#    with:
+#      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+
+
+  HTMLDocumentation:
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r1
     needs:
-      - Params
-      - BuildTheDocs
+      - UnitTestingParams
+      - PublishTestResults
+      - PublishCoverageResults
+#      - VerifyDocs
     with:
-      doc: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-ubuntu-native-3.12
+      coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+      html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
 
-# TODO: this is disabled until some package exists.
-#  ArtifactCleanUp:
-#    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r0
+#  PDFDocumentation:
+#    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r1
 #    needs:
-#      - Params
-#      - BuildTheDocs
-#      - PublishToGitHubPages
+#      - UnitTestingParams
+#      - HTMLDocumentation
 #    with:
-#      package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
-#      remaining: |
-#        ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
+#      document: sphinx_reports
+#      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+#      pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
+
+  PublishToGitHubPages:
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r1
+    needs:
+      - UnitTestingParams
+      - HTMLDocumentation
+#      - PDFDocumentation
+      - PublishCoverageResults
+      - StaticTypeCheck
+    with:
+      doc: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+#      coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
+      typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
+
+  ReleasePage:
+    uses: pyTooling/Actions/.github/workflows/Release.yml@r1
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - Package
+      - PublishToGitHubPages
+
+  PublishOnPyPI:
+    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r1
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - UnitTestingParams
+      - ReleasePage
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      requirements: -r dist/requirements.txt
+      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  ArtifactCleanUp:
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r1
+    needs:
+      - UnitTestingParams
+      - UnitTesting
+      - StaticTypeCheck
+      - HTMLDocumentation
+#      - PDFDocumentation
+      - PublishTestResults
+      - PublishCoverageResults
+      - PublishToGitHubPages
+#      - PublishOnPyPI
+    with:
+      package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+      remaining: |
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+#        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
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/**/*.*
@@ -15,11 +22,16 @@ coverage.xml
 # Dependencies
 !requirements.txt
 
-# Sphinx documentation
-/doc/_build/
-/doc/_theme/
-/doc/pyEDAA.Reports/**/*.*
-!/doc/pyEDAA.Reports/index.rst
+# Sphinx
+doc/_build/
+doc/pyEDAA.Reports/**/*.*
+!doc/pyEDAA.Reports/index.rst
 
-# PyCharm project
+# BuildTheDocs
+doc/_theme/**/*.*
+
+# IntelliJ project files
 /.idea/workspace.xml
+
+# Git files
+!.git*
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/pyEDAA.Reports.iml b/.idea/pyEDAA.Reports.iml