Merge pull request #44 from dnv-opensource/43-brake-the-link-to-marit…

…ime-schema

43 brake the link to maritime schema

.coveragerc

@@ -0,0 +1,13 @@
+[paths]
+source =
+    src/trafficgen
+    */site-packages/trafficgen
+
+[run]
+source = trafficgen
+branch = True
+
+[report]
+fail_under = 10.0
+show_missing = True
+skip_covered = True

.editorconfig

@@ -6,7 +6,6 @@ root = true
 [*]
 indent_style = space
 indent_size = 4
-end_of_line = crlf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true

.github/workflows/_build_and_publish_documentation.yml

@@ -15,19 +15,18 @@ jobs:
       - name: Checkout active branch
         uses: actions/checkout@v4
         with:
-          fetch-depth: 1
           lfs: true
-      - name: Install Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
         with:
-          python-version: '3.11'
-          cache: 'pip' # cache pip dependencies
-      - uses: actions/download-artifact@v4
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          name: requirements-files
-      - name: Install dependencies
-        run: |
-          pip install -r requirements-docs.txt
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --upgrade
       - name: Print debugging information
         run: |
           echo "github.ref:" ${{github.ref}}
@@ -39,17 +38,15 @@ jobs:
           git branch
           git branch -a
           git remote -v
-          python -V
-          pip list --not-required
-          pip list
+          uv run python -V
+          uv pip list
 
       # Build documentation
       - uses: sphinx-doc/github-problem-matcher@master
       - name: Build documentation
         run: |
           cd docs
-          sphinx-apidoc -f -e -M -o . ../src/trafficgen
-          make html
+          uv run make html
 
       - name: Clone and cleanup gh-pages branch
         run: |

.github/workflows/_build_package.yml

@@ -9,46 +9,21 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 1
           lfs: true
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
-          cache: 'pip' # cache pip dependencies
-      - name: Install build and twine
-        run: pip install build twine
-      - name: Run build
-        run: python -m build
+          python-version-file: "pyproject.toml"
+      - name: Build source distribution and wheel
+        run: uv build
       - name: Run twine check
-        run: twine check --strict dist/*
+        run: uvx twine check --strict dist/*
       - uses: actions/upload-artifact@v4
         with:
-          path: ./dist/*.tar.gz
-
-  # build_wheels:
-  #   name: Build wheels for ${{ matrix.platform }}
-  #   needs:
-  #     - black
-  #     - ruff
-  #     - pyright
-  #     - test
-  #   runs-on: ${{ matrix.platform }}
-  #   strategy:
-  #     matrix:
-  #       platform: [ubuntu-latest, macos-latest, windows-latest]
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #       with:
-  #         fetch-depth: 1
-  #         lfs: true
-  #     - uses: actions/setup-python@v5
-  #       with:
-  #         python-version: '3.11'
-  #         cache: 'pip' # cache pip dependencies
-  #     - name: Install cibuildwheel
-  #       run: python -m pip install cibuildwheel==2.16
-  #     - name: Build wheels
-  #       run: python -m cibuildwheel --output-dir wheels
-  #     - uses: actions/upload-artifact@v4
-  #       with:
-  #         path: ./wheels/*.whl
+          path: |
+            dist/*.tar.gz
+            dist/*.whl

.github/workflows/_code_quality.yml

@@ -3,55 +3,78 @@ name: Code Quality
 on: workflow_call
 
 jobs:
-  black:
-    name: black
+  ruff_format:
     runs-on: ubuntu-latest
+    name: ruff format
     steps:
       - uses: actions/checkout@v4
-      - uses: psf/black@stable
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
         with:
-          options: '--check --diff'
-          src: '.'
-          jupyter: true
-          version: '==23.12'
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --upgrade
+      - name: Run ruff format
+        run: uv run ruff format --diff
 
-  ruff:
+  ruff_check:
     runs-on: ubuntu-latest
-    name: ruff
+    name: ruff check
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.11'
-          cache: 'pip' # cache pip dependencies
-      - uses: actions/download-artifact@v4
-        with:
-          name: requirements-files
-      - name: Install dependencies
-        run: |
-          pip install -r requirements.txt
-      - name: Install ruff
-        run: pip install ruff==0.1.8
-      - name: Run ruff
-        run: ruff .
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --upgrade
+      - name: Run ruff check
+        run: uv run ruff check --diff
 
   pyright:
     runs-on: ubuntu-latest
     name: pyright
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.11'
-          cache: 'pip' # cache pip dependencies
-      - uses: actions/download-artifact@v4
-        with:
-          name: requirements-files
-      - name: Install dependencies
-        run: |
-          pip install -r requirements.txt
-          pip install pytest
-      - name: Install pyright
-        run: pip install pyright==1.1.338
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --upgrade
       - name: Run pyright
-        run: pyright .
+        run: uv run pyright
+
+  mypy:
+    runs-on: ubuntu-latest
+    name: mypy
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install the project
+        run: uv sync --upgrade
+      - name: Run mypy
+        run: uv run mypy

.github/workflows/_merge_into_release.yml

@@ -22,4 +22,10 @@ jobs:
         with:
           type: now
           target_branch: release
-          github_token: ${{ secrets.RELEASE_TOKEN }}
+          # @TODO: A dedicated RELEASE_TOKEN should be created in the repo settings
+          #        and used for this task when in production.
+          #        It is set here to the default GITHUB_TOKEN only
+          #        for demonstration purposes, enabling the workflow in the repo template
+          #        to run without additional configuration.
+          # github_token: ${{ secrets.RELEASE_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/_test.yml

@@ -4,32 +4,31 @@ on: workflow_call
 
 jobs:
   test:
-    name: Test on ${{matrix.python.toxenv}}-${{matrix.platform.toxenv}}
+    name: Test on ${{matrix.python.version}}-${{matrix.platform.runner}}
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
         platform:
           - runner: ubuntu-latest
-            toxenv: linux
           - runner: windows-latest
-            toxenv: windows
+          # - runner: macos-latest
         python:
-          - version: '3.9'
-            toxenv: 'py39'
-          - version: '3.10'
-            toxenv: 'py310'
           - version: '3.11'
-            toxenv: 'py311'
           - version: '3.12'
-            toxenv: 'py312'
     steps:
       - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
       - name: Install Python ${{ matrix.python.version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python.version }}
-          cache: 'pip' # cache pip dependencies
-      - name: Install tox
-        run: python -m pip install tox
+      - name: Install the project
+        run: uv sync -p ${{ matrix.python.version }} -U --no-dev
       - name: Run pytest
-        run: tox -e ${{matrix.python.toxenv}}-${{matrix.platform.toxenv}}
+        run: >
+          uv run --with pytest --with pytest-cov
+          pytest --cov

.github/workflows/_test_future.yml

@@ -1,31 +1,35 @@
-name: Unit Tests (py312)
-# Test also with Python 3.12 (experimental; workflow will not fail on error.)
+name: Unit Tests (py313)
+# Test also with Python 3.13 (experimental; workflow will not fail on error.)
 
 on: workflow_call
 
 jobs:
-  test312:
-    name: Test on ${{matrix.python.toxenv}}-${{matrix.platform.toxenv}} (experimental)
+  test313:
+    name: Test on ${{matrix.python.version}}-${{matrix.platform.runner}} (experimental)
     continue-on-error: true
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
         platform:
           - runner: ubuntu-latest
-            toxenv: linux
           - runner: windows-latest
-            toxenv: windows
         python:
-          - version: '3.13.0a2'
-            toxenv: 'py313'
+          - version: '3.13.0-alpha - 3.13.0'
+            uvpy: '3.13'
     steps:
       - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
       - name: Install Python ${{ matrix.python.version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python.version }}
-          cache: 'pip' # cache pip dependencies
-      - name: Install tox
-        run: python -m pip install tox
+      - name: Install the project
+        run: uv sync -p ${{ matrix.python.uvpy }} -U --no-dev
       - name: Run pytest
-        run: tox -e ${{matrix.python.toxenv}}-${{matrix.platform.toxenv}}
+        run: >
+          uv run --with pytest --with pytest-cov
+          pytest --cov