ods-exd-api-box 1.0.1__tar.gz

ods_exd_api_box-1.0.1/.commitlintrc.json

@@ -0,0 +1,55 @@
+{
+    "extends": [
+        "@commitlint/config-conventional"
+    ],
+    "rules": {
+        "type-enum": [
+            2,
+            "always",
+            [
+                "feat",
+                "fix",
+                "docs",
+                "style",
+                "refactor",
+                "perf",
+                "test",
+                "chore",
+                "ci",
+                "revert"
+            ]
+        ],
+        "type-case": [
+            2,
+            "always",
+            "always-lowercase"
+        ],
+        "type-empty": [
+            2,
+            "never"
+        ],
+        "subject-empty": [
+            2,
+            "never"
+        ],
+        "subject-full-stop": [
+            2,
+            "never",
+            "."
+        ],
+        "subject-case": [
+            2,
+            "never",
+            [
+                "start-case",
+                "pascal-case",
+                "upper-case"
+            ]
+        ],
+        "header-max-length": [
+            2,
+            "always",
+            100
+        ]
+    }
+}

ods_exd_api_box-1.0.1/.devcontainer/devcontainer.json

@@ -0,0 +1,52 @@
+{
+    "name": "ODS EXD API Box Dev Container",
+    "image": "mcr.microsoft.com/vscode/devcontainers/python:3.12-bookworm",
+    "features": {
+        "docker-in-docker": {
+            "version": "latest",
+            "moby": true,
+            "dockerDashComposeVersion": "v1"
+        }
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "ms-python.debugpy",
+                "ms-python.black-formatter",
+                "charliermarsh.ruff",
+                "ms-vscode.makefile-tools",
+                "github.copilot",
+                "github.copilot-chat",
+                "ms-python.isort",
+                "ms-python.mypy-type-checker",
+                "streetsidesoftware.code-spell-checker"
+            ],
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python",
+                "python.linting.enabled": true,
+                "python.linting.pylintEnabled": false,
+                "python.linting.flake8Enabled": true,
+                "python.formatting.provider": "black",
+                "[python]": {
+                    "editor.defaultFormatter": "ms-python.python",
+                    "editor.formatOnSave": true,
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": "explicit"
+                    }
+                },
+                "python.testing.unittestArgs": [
+                    "-v",
+                    "-s",
+                    "./tests",
+                    "-p",
+                    "test_*.py"
+                ],
+                "python.testing.unittestEnabled": true
+            }
+        }
+    },
+    "postCreateCommand": "pip install --upgrade pip && pip install -e . && pip install -e '.[dev]' && pre-commit install --install-hooks && pre-commit install --hook-type commit-msg",
+    "remoteUser": "vscode"
+}

ods_exd_api_box-1.0.1/.gitattribute

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

ods_exd_api_box-1.0.1/.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    reviewers:
+      - totonga
+    allow:
+      - dependency-type: direct
+      - dependency-type: indirect
+    commit-message:
+      prefix: "fix: "
+    target-branch: develop
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "fix: "
+    target-branch: develop

ods_exd_api_box-1.0.1/.github/workflows/build.yml

@@ -0,0 +1,105 @@
+name: Build, Test and Release
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build wheel setuptools setuptools-scm
+
+    - name: Install package with dev dependencies
+      run: |
+        pip install -e '.[dev]'
+
+    - name: Run tests
+      run: |
+        python -m unittest
+
+    - name: Build distributions
+      run: |
+        python -m build
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v6
+      with:
+        name: python-package-distributions
+        path: dist/
+        retention-days: 7
+
+  release:
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Release
+      id: release
+      uses: python-semantic-release/python-semantic-release@v10.5.3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        git_committer_name: "github-actions"
+        git_committer_email: "actions@users.noreply.github.com"
+
+    - name: Install build dependencies
+      if: steps.release.outputs.released == 'true'
+      run: |
+        python -m pip install --upgrade pip
+        pip install build wheel setuptools setuptools-scm
+
+    - name: Rebuild distributions (if released)
+      if: steps.release.outputs.released == 'true'
+      run: |
+        rm -rf dist/
+        python -m build
+
+    - name: Create Release with artifacts
+      if: steps.release.outputs.released == 'true'
+      uses: softprops/action-gh-release@v2
+      with:
+        tag_name: v${{ steps.release.outputs.version }}
+        files: dist/*
+        token: ${{ github.token }}
+
+    - name: Publish to PyPI
+      if: steps.release.outputs.released == 'true'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        packages-dir: dist/

ods_exd_api_box-1.0.1/.github/workflows/pr-validation.yml

@@ -0,0 +1,85 @@
+name: PR Validation
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+permissions:
+  pull-requests: read
+  contents: read
+
+jobs:
+  validate-commits:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Set up Node.js (for commitlint)
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+
+    - name: Install commitlint
+      run: |
+        npm install --global @commitlint/cli @commitlint/config-conventional
+
+    - name: Validate PR title (as fallback)
+      run: |
+        TITLE="${{ github.event.pull_request.title }}"
+        VALID_PREFIXES=("feat" "fix" "docs" "style" "refactor" "perf" "test" "chore" "ci" "revert")
+
+        PREFIX=$(echo "$TITLE" | sed -n 's/^\([a-z]*\).*/\1/p')
+
+        if [[ ! " ${VALID_PREFIXES[@]} " =~ " ${PREFIX} " ]]; then
+          echo "❌ PR title must start with a valid conventional commit prefix!"
+          echo "Valid prefixes: ${VALID_PREFIXES[*]}"
+          echo "Your PR title: $TITLE"
+          echo ""
+          echo "Examples of valid titles:"
+          echo "  - feat: add new data query feature"
+          echo "  - fix: resolve connection timeout issue"
+          echo "  - docs: update API documentation"
+          exit 1
+        fi
+
+        echo "✅ PR title follows conventional commit format: '$TITLE'"
+
+    - name: Validate commit messages
+      run: |
+        # Get all commits in the PR
+        commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }}
+      continue-on-error: true
+
+  lint-python:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e '.[dev]'
+
+    - name: Run flake8
+      run: |
+        flake8 ods_exd_api_box/ tests/ || true
+
+    - name: Run black check
+      run: |
+        black --check ods_exd_api_box/ tests/ || true
+
+    - name: Run isort check
+      run: |
+        isort --check-only ods_exd_api_box/ tests/ || true

ods_exd_api_box-1.0.1/.gitignore

@@ -0,0 +1,7 @@
+*.proto
+.venv/
+__pycache__
+build/
+dist/
+*.egg-info/
+.mypy_cache/

ods_exd_api_box-1.0.1/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+repos:
+  # Commit message linting
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.1.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+
+  # Code formatting
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        language_version: python3.12
+        exclude: ^ods_exd_api_box/proto/
+
+  # Import sorting
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+        exclude: ^ods_exd_api_box/proto/
+
+  # Linting
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+        args: ["--max-line-length=119", "--extend-ignore=E203,W503,W293"]
+        exclude: ^ods_exd_api_box/proto/
+
+  # Type checking
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.0
+    hooks:
+      - id: mypy
+        additional_dependencies: ["pandas-stubs"]
+        args: [--python-version=3.12, --no-error-summary]
+        exclude: ^(tests/|ods_exd_api_box/proto/)
+
+  # General file checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: detect-private-key
+
+# Local configuration
+default_stages: [pre-commit]
+fail_fast: false

ods_exd_api_box-1.0.1/.releaserc.json

@@ -0,0 +1,111 @@
+{
+    "extends": [
+        "semantic-release:commit-analyzer-default"
+    ],
+    "branches": [
+        "main",
+        {
+            "name": "develop",
+            "prerelease": "alpha"
+        }
+    ],
+    "plugins": [
+        [
+            "@semantic-release/commit-analyzer",
+            {
+                "preset": "conventional",
+                "releaseRules": [
+                    {
+                        "type": "feat",
+                        "release": "minor"
+                    },
+                    {
+                        "type": "fix",
+                        "release": "patch"
+                    },
+                    {
+                        "type": "perf",
+                        "release": "patch"
+                    },
+                    {
+                        "type": "docs",
+                        "scope": "README",
+                        "release": "patch"
+                    },
+                    {
+                        "type": "refactor",
+                        "release": "patch"
+                    }
+                ]
+            }
+        ],
+        [
+            "@semantic-release/release-notes-generator",
+            {
+                "preset": "conventionalcommits",
+                "presetConfig": {
+                    "types": [
+                        {
+                            "type": "feat",
+                            "section": "Features",
+                            "hidden": false
+                        },
+                        {
+                            "type": "fix",
+                            "section": "Bug Fixes",
+                            "hidden": false
+                        },
+                        {
+                            "type": "perf",
+                            "section": "Performance",
+                            "hidden": false
+                        },
+                        {
+                            "type": "docs",
+                            "section": "Documentation",
+                            "hidden": false
+                        },
+                        {
+                            "type": "refactor",
+                            "section": "Refactoring",
+                            "hidden": false
+                        },
+                        {
+                            "type": "test",
+                            "section": "Tests",
+                            "hidden": true
+                        },
+                        {
+                            "type": "chore",
+                            "section": "Chores",
+                            "hidden": true
+                        }
+                    ]
+                }
+            }
+        ],
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogFile": "CHANGELOG.md"
+            }
+        ],
+        [
+            "@semantic-release/git",
+            {
+                "assets": [
+                    "CHANGELOG.md",
+                    "pyproject.toml"
+                ],
+                "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+            }
+        ],
+        "@semantic-release/github",
+        [
+            "@semantic-release/npm",
+            {
+                "npmPublish": false
+            }
+        ]
+    ]
+}

ods_exd_api_box-1.0.1/.vscode/settings.json

@@ -0,0 +1,51 @@
+{
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "files.trimTrailingWhitespace": true,
+    "files.autoSave": "onFocusChange",
+    "flake8.args": [
+        "--max-line-length=119"
+    ],
+    "black-formatter.args": [
+        "--line-length=119"
+    ],
+    "pylint.args": [
+        "--max-line-length=119"
+    ],
+    "editor.codeActionsOnSave": {
+        "source.organizeImports": "explicit"
+    },
+    "cSpell.words": [
+        "appuser",
+        "DCOMPLEX",
+        "dtypes",
+        "grpcio",
+        "isort",
+        "issubdtype",
+        "jupyterlab",
+        "mypy",
+        "nptdms",
+        "protoc",
+        "pylint",
+        "pyproject",
+        "setuptools",
+        "Tdms",
+        "tobytes",
+        "totonga"
+    ],
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.rulers": [
+            119
+        ]
+    },
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "test_*.py"
+    ],
+    "python.testing.unittestEnabled": true
+}

ods_exd_api_box-1.0.1/CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

ods_exd_api_box-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Andreas K
+
+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.

ods_exd_api_box-1.0.1/MANIFEST.in

@@ -0,0 +1,5 @@
+
+# Project documentation and metadata
+include README.md
+include LICENSE
+include pyproject.toml