V5 Release

.github/workflows/ci.yml

@@ -0,0 +1,126 @@
+name: CI
+
+on:
+    pull_request:
+    push:
+    workflow_dispatch:
+
+permissions:
+  checks: write
+  contents: write
+  # deployments permission to deploy GitHub pages website
+  deployments: write
+  pull-requests: write
+
+
+jobs:
+    python-unit:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        defaults:
+            run:
+                working-directory: .
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v5
+              with:
+                python-version: ${{ matrix.python-version }}
+                cache: 'pip'
+                cache-dependency-path: '**/pyproject.toml'
+
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install .[test]
+
+            - name: Check Python linting (Ruff)
+              run: ruff check --output-format=github
+
+            - name: Check Python formatting (Ruff)
+              run: ruff format --check
+
+            - name: Run unit tests
+              run: |
+                pytest --junitxml=junit_pytest_main.xml --cov-report=term-missing:skip-covered
+                mv .coverage .coverage_main
+
+            - name: Run Django integration tests
+              working-directory: ./edtf_django_tests
+              run: |
+                pytest edtf_integration/tests.py --ds=edtf_django_tests.settings --junitxml=../junit_pytest_django.xml --cov-report=term-missing:skip-covered
+                mv .coverage ../.coverage_django
+
+            - name: Combine coverage reports
+              run: |
+                coverage combine .coverage_main .coverage_django
+                coverage report --omit="edtf_django_tests/*"
+                coverage xml -o coverage_combined.xml --omit="edtf_django_tests/*"
+
+            - name: Combine JUnit XML reports
+              run: |
+                python combine_junit.py combined_junit_pytest.xml junit_pytest_main.xml junit_pytest_django.xml
+
+            - name: Pytest coverage comment
+              id: coverageComment
+              uses: MishaKav/pytest-coverage-comment@main
+              with:
+                pytest-xml-coverage-path: ./coverage_combined.xml
+                junitxml-path: ./combined_junit_pytest.xml
+                unique-id-for-comment: ${{ matrix.python-version }}
+                github-token: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Check the output coverage
+              run: |
+                echo "Coverage Percentage - ${{ steps.coverageComment.outputs.coverage }}"
+                echo "Coverage Color - ${{ steps.coverageComment.outputs.color }}"
+                echo "Coverage Html - ${{ steps.coverageComment.outputs.coverageHtml }}"
+                echo "Summary Report -" ${{ steps.coverageComment.outputs.summaryReport }}
+                echo "Coverage Warnings - ${{ steps.coverageComment.outputs.warnings }}"
+                echo "Coverage Errors - ${{ steps.coverageComment.outputs.errors }}"
+                echo "Coverage Failures - ${{ steps.coverageComment.outputs.failures }}"
+                echo "Coverage Skipped - ${{ steps.coverageComment.outputs.skipped }}"
+                echo "Coverage Tests - ${{ steps.coverageComment.outputs.tests }}"
+                echo "Coverage Time - ${{ steps.coverageComment.outputs.time }}"
+                echo "Not Success Test Info - ${{ steps.coverageComment.outputs.notSuccessTestInfo }}"
+
+            - name: Run benchmarks
+              run: |
+                pytest -m benchmark --benchmark-json=./output.json
+
+            - name: Download previous benchmark data
+              uses: actions/cache@v4
+              with:
+                path: ./cache
+                key: ${{ runner.os }}-benchmark
+
+            - name: Publish benchmark results
+              uses: benchmark-action/github-action-benchmark@v1
+              if: github.event_name == 'pull_request' && github.repository == 'ixc/python-edtf'
+              with:
+                tool: 'pytest'
+                auto-push: true
+                comment-always: true
+                output-file-path: output.json
+                github-token: ${{ secrets.GITHUB_TOKEN }}
+                comment-on-alert: true
+                save-data-file: true
+                summary-always: true
+
+            - name: Comment on benchmark results without publishing
+              if: github.event_name != 'pull_request' || github.repository != 'ixc/python-edtf'
+              uses: benchmark-action/github-action-benchmark@v1
+              with:
+                tool: 'pytest'
+                auto-push: false
+                github-token: ${{ secrets.GITHUB_TOKEN }}
+                comment-always: true
+                output-file-path: output.json
+                comment-on-alert: false
+                save-data-file: true
+                summary-always: true
+                external-data-json-path: ./cache/benchmark-data.json

.github/workflows/coverage_readme.yml

@@ -0,0 +1,68 @@
+name: Update Coverage on Readme
+on:
+  push:
+    branches:
+      - main
+
+# https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
+# `contents` is for permission to the contents of the repository.
+# `pull-requests` is for permission to pull request
+permissions:
+  contents: write
+  checks: write
+  pull-requests: write
+
+# see: https://github.com/MishaKav/pytest-coverage-comment
+jobs:
+  update-coverage-on-readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: 'pip'
+          cache-dependency-path: '**/pyproject.toml'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[test]
+
+      - name: Run tests and generate coverage
+        run: |
+          pytest
+          mv .coverage .coverage_main
+          cd edtf_django_tests
+          coverage run manage.py test edtf_integration
+          mv .coverage ../.coverage_django
+          cd ..
+          coverage combine .coverage_main .coverage_django
+          coverage report --omit="edtf_django_tests/*"
+          coverage xml -o coverage_combined.xml --omit="edtf_django_tests/*"
+
+      - name: Pytest coverage comment
+        if: ${{ github.ref == 'refs/heads/main' }}
+        id: coverageComment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-xml-coverage-path: ./coverage_combined.xml
+          hide-comment: true
+
+      - name: Update Readme with Coverage Html
+        if: ${{ github.ref == 'refs/heads/main' }}
+        run: |
+          sed -i '/<!-- Pytest Coverage Comment:Begin -->/,/<!-- Pytest Coverage Comment:End -->/c\<!-- Pytest Coverage Comment:Begin -->\n\${{ steps.coverageComment.outputs.coverageHtml }}\n<!-- Pytest Coverage Comment:End -->' ./README.md
+
+      - name: Commit & Push changes to README
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add README.md
+          git commit -m 'Update coverage badge in README'
+          git push

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+venv/
 build/
 develop-eggs/
 dist/
@@ -41,14 +42,22 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage_combined.xml
+.coverage_main
+.coverage_django
 *,cover
+combined_junit_pytest.xml
+pytest.xml
+junit_pytest_main.xml
+junit_pytest_django.xml
 
 # Translations
 *.mo
 *.pot
 
 # Django stuff:
 *.log
+db.sqlite3
 
 # Sphinx documentation
 docs/_build/

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: end-of-file-fixer
+        exclude: "business-facing/layer"
+      - id: trailing-whitespace
+        exclude: "business-facing/layer"
+      - id: check-yaml
+        exclude: "business-facing/layer"
+      - id: check-json
+        exclude: "business-facing/layer"
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+    rev: v0.4.4
+    hooks:
+      # Run the linter, and enable lint fixes
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2015 The Interaction Consortium
+Copyright (c) 2023 SAW Leipzig
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal