vdoc 0.1.0__tar.gz

vdoc-0.1.0/.cruft.json

@@ -0,0 +1,28 @@
+{
+  "template": "git@github.com:vorausrobotik/voraus-cookiecutter-pypackage.git",
+  "commit": "5a518fdfdcdf9db123bd1fc2ccf9953ee3df7e9a",
+  "checkout": "development",
+  "context": {
+    "cookiecutter": {
+      "full_name": "Jan-Frederik Schmidt",
+      "email": "jan-frederik.schmidt@vorausrobotik.com",
+      "github_user": "g3n35i5",
+      "project_name": "vdoc",
+      "repo_name": "vdoc",
+      "package_name": "vdoc",
+      "import_name": "vdoc",
+      "project_short_description": "Multi version documentation hosting.",
+      "url": "https://github.com/vorausrobotik/vdoc",
+      "_debug": "False",
+      "_extensions": [
+        "extensions.git_extension.GitExtension"
+      ],
+      "_copy_without_render": [
+        "docs/_templates/license_compliance.rst.j2",
+        "jreleaser.yml"
+      ],
+      "_template": "git@github.com:vorausrobotik/voraus-cookiecutter-pypackage.git"
+    }
+  },
+  "directory": null
+}

vdoc-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @g3n35i5

vdoc-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,46 @@
+name: Build
+
+on: [workflow_call]
+
+jobs:
+  build-wheel:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.13
+
+    - name: Install npm dependencies
+      run: npm ci
+
+    - name: Install tox
+      run: python -m pip install --upgrade tox==4.23.2 tox-uv~=1.16.0
+
+    - name: Build docs
+      run: tox run -e docs
+
+    - name: Build UI
+      run: npm run build
+
+    - name: Build python app
+      run: tox run -e build
+
+    - name: Upload python artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: dist
+        path: dist/*
+
+    - name: Upload docs
+      uses: actions/upload-artifact@v4
+      with:
+        name: docs
+        path: src/vdoc/docs/*

vdoc-0.1.0/.github/workflows/linting.yml

@@ -0,0 +1,39 @@
+name: Linting
+
+on: [workflow_call]
+
+jobs:
+  lint-python:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Install tox
+      run: python -m pip install --upgrade tox==4.23.2 tox-uv~=1.16.0
+
+    - name: Run static checks
+      run: tox -e lint
+
+  lint-ts:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+
+    - name: Install Dependencies
+      run: npm ci
+
+    - name: Lint UI
+      run: npm run lint

vdoc-0.1.0/.github/workflows/pipeline.yml

@@ -0,0 +1,155 @@
+name: CI pipeline
+
+permissions:
+  contents: write
+  id-token: write
+  issues: write
+  pages: write
+
+on:
+  pull_request:
+    branches:
+    - main
+  push:
+    branches:
+    - "main"
+    tags:
+      - '*'
+
+jobs:
+  tests-and-coverage:
+    uses: ./.github/workflows/tests_and_coverage.yml
+  linting:
+    uses: ./.github/workflows/linting.yml
+  build:
+    uses: ./.github/workflows/build.yml
+  publish-pypi:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    needs:
+      - tests-and-coverage
+      - linting
+      - build
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        env:
+          url: https://pypi.org/p/vdoc
+
+  publish-docker:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    needs:
+      - tests-and-coverage
+      - linting
+      - build
+    env:
+      IMAGE_NAME: voraus.jfrog.io/docker-public/vdoc
+      JFROG_CLI_BUILD_NAME: vdoc/${{ github.ref_name }}
+      JFROG_CLI_BUILD_NUMBER: '1'
+    steps:
+      - uses: jfrog/setup-jfrog-cli@v4
+        env:
+            JF_URL: https://voraus.jfrog.io
+        with:
+            oidc-provider-name: voraus-github-organization
+
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Determine Docker tags
+        id: set-tags
+        run: |
+          TAG="${{ github.ref_name }}"
+          LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
+
+          TAGS="${IMAGE_NAME}:${TAG}"
+          if [[ "$TAG" == "$LATEST_TAG" ]]; then
+            TAGS="${TAGS},${IMAGE_NAME}:latest"
+          fi
+
+          echo "tags=$TAGS" >> $GITHUB_OUTPUT
+
+      - name: Build Docker Image(s)
+        run: |
+          IFS=',' read -ra TAG_ARRAY <<< "${{ steps.set-tags.outputs.tags }}"
+          TAG_OPTIONS=$(printf " -t %s" "${TAG_ARRAY[@]}")
+          jf docker build $TAG_OPTIONS .
+
+      - name: Push and scan Docker Image(s)
+        run: |
+          IFS=',' read -ra TAG_ARRAY <<< "${{ steps.set-tags.outputs.tags }}"
+          for TAG in "${TAG_ARRAY[@]}"; do
+            jf docker push "$TAG"
+            jf docker scan "$TAG"
+          done
+
+      - name: Publish Build Info
+        run: |
+          jf rt build-publish
+
+  create-github-release:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    needs:
+      - publish-docker
+      - publish-pypi
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run JReleaser
+        uses: jreleaser/release-action@v2
+        with:
+          version: 1.13.1
+        env:
+          JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          JRELEASER_PROJECT_VERSION: ${{ github.ref_name }}
+
+  publish-docs:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    needs:
+      - tests-and-coverage
+      - linting
+      - build
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

vdoc-0.1.0/.github/workflows/pr_lint.yml

@@ -0,0 +1,47 @@
+name: Pull Request Lint
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize, labeled, unlabeled]
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: Validate PR title and description
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          requireScope: false
+          # Configure additional validation for the subject based on a regex.
+          # This ensures the subject does start with an uppercase character.
+          subjectPattern: ^(?![a-z])(?![a-zA-Z]+s\s(?<!ss\s)).+[^\.\?\!]$
+          # If `subjectPattern` is configured, you can use this property to override
+          # the default error message that is shown when the pattern doesn't match.
+          # The variables `subject` and `title` can be used within the message.
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that:
+            - The subject does start with an uppercase character
+            - The subject does not end with a dot, question or exclamation mark
+            - The subject uses imperative mood
+          # If the PR contains one of these newline-delimited labels, the
+          # validation is skipped.
+          ignoreLabels: |
+            rebase
+      - name: Validate PR body is filled
+        env:
+          BODY_CONTEXT: ${{ toJson(github.event.pull_request.body) }}
+        run: |
+          if [ "$BODY_CONTEXT" = "null" ];\
+          then\
+            echo "Error: The pull request body is empty." &&\
+            echo "Please add a description why the change is necessary and link tickets." &&\
+            (exit 1);
+          else\
+            echo "PR Body is not empty. Check passed.";\
+          fi\

vdoc-0.1.0/.github/workflows/python_template_update_checks.yml

@@ -0,0 +1,15 @@
+name: Python template update checks
+on:
+  push:
+    branches:
+      - "chore/update-template**"
+jobs:
+  fail-if-rej-files-exist:
+    name: "Check for rejected files"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Assert that 0 files ending with '.rej' are in the current working directory.
+      # `xargs` returns 0 on success, otherwise status codes between 1 and 127, see
+      # https://man7.org/linux/man-pages/man1/xargs.1.html for details.
+      - run: find . -iname "*.rej" | wc -l | xargs -I % test % -eq 0

vdoc-0.1.0/.github/workflows/tests_and_coverage.yml

@@ -0,0 +1,84 @@
+name: Tests & Coverage
+
+on: [workflow_call]
+
+
+jobs:
+  test-python:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tox
+      run: python -m pip install --upgrade pip tox==4.23.2 tox-uv~=1.16.0 tox-gh-actions~=3.0
+
+    - name: Run tests
+      run: tox
+
+    - name: Upload coverage artifact
+      if: matrix.os == 'ubuntu-latest'
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-${{ matrix.python-version }}
+        path: reports/.coverage.*test
+        include-hidden-files: true
+
+  coverage-python:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: test-python
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download all coverage artifacts
+        uses: actions/download-artifact@v4
+        with:
+          merge-multiple: true
+          path: reports
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install tox
+        run: python -m pip install --upgrade pip tox
+
+      - name: Combine coverage results
+        run: tox run -e combine-test-reports
+
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage-report
+          path: reports/coverage.xml
+
+  test-ui:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Run UI unit tests
+        run: npm run test:unit

vdoc-0.1.0/.gitignore

@@ -0,0 +1,69 @@
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# General
+output/
+.tox/
+reports/
+.coverage
+.coverage.*
+MANIFEST
+docs/vdoc*
+docs/modules.rst
+docs/ossLicenses.json
+docs/license_compliance.rst
+.env
+
+# Build and package files
+**/*.egg-info/
+**/build/**/*
+node_modules/
+dist/
+.jfrog/
+*.class
+*.py[cod]
+*.jar
+vdoc-[0-9]*
+
+# Log files
+**/log/**/*
+*.log
+
+# IDEs
+.idea/
+.vscode/
+
+# Virtual environments
+venv*/
+.venv/
+.conda/
+
+# Cache directories
+.mypy_cache
+.pytest_cache
+.ruff_cache
+
+# Generated by OS
+.DS_Store
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+
+src/vdoc/webapp/
+src/vdoc/docs/
+
+# Local development files and documentation
+vdoc-docs

vdoc-0.1.0/.prettierignore

@@ -0,0 +1,9 @@
+# Ignore folders:
+venv/**
+.tox/**
+docs/**
+reports/**
+.cruft.json
+.devcontainer/**
+.github/**
+src/ui/routeTree.gen.ts

vdoc-0.1.0/.prettierrc.yml

@@ -0,0 +1,5 @@
+trailingComma: 'es5'
+tabWidth: 2
+semi: false
+singleQuote: true
+printWidth: 120

vdoc-0.1.0/Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.13-alpine
+
+ENV PYTHONDONTWRITEBYTECODE=1
+
+EXPOSE 8080
+ENTRYPOINT [ "vdoc" ]
+CMD []
+
+RUN --mount=type=bind,source=./dist/,target=/pip-packages/ \
+    pip install \
+    --no-cache-dir \
+    --no-compile \
+    --upgrade \
+    /pip-packages/*.whl

vdoc-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 voraus robotik GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.