s2dm 0.16.2__tar.gz

s2dm-0.16.2/.bumpversion.toml

@@ -0,0 +1,24 @@
+[tool.bumpversion]
+current_version = "0.16.2"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+ignore_missing_files = false
+tag = true
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = false
+message = "chore: bump version {current_version} → {new_version}"
+moveable_tags = []
+commit_args = ""
+
+[[tool.bumpversion.files]]
+filename = "src/s2dm/__init__.py"
+
+[[tool.bumpversion.files]]
+filename = "tests/test_s2dm.py"

s2dm-0.16.2/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+      - "github-actions"
+
+  # Enable version updates for Python packages
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+      - "python"

s2dm-0.16.2/.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: ci
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: setup node
+        uses: actions/setup-node@v6
+        with:
+          node-version: "20"
+
+      - name: install node dependencies
+        run: npm install
+
+      - name: uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: sync
+        run: |
+          uv sync --frozen
+
+      - name: pre-commit
+        run: |
+          uv run pre-commit run --all-files
+
+      - name: gitlint
+        run: |
+          # Determine base branch - use PR base if in PR, otherwise main
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            BASE_BRANCH="${{ github.base_ref }}"
+          else
+            BASE_BRANCH="main"
+          fi
+          echo "Using base branch: $BASE_BRANCH"
+          # Run gitlint on commits since base branch
+          uv run gitlint --commits $(git merge-base HEAD origin/$BASE_BRANCH)..HEAD
+
+      - name: mypy
+        run: |
+          uv run mypy src/ tests/
+
+      - name: test
+        run: |
+          uv run nox

s2dm-0.16.2/.github/workflows/docgen.yml

@@ -0,0 +1,85 @@
+name: Deploy S2DM site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.147.9
+    steps:
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: 'docs-gen/package-lock.json'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        working-directory: ./docs-gen
+        run: npm ci
+      - name: Build production website
+        working-directory: ./docs-gen
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+          TZ: America/Los_Angeles
+        run: |
+          hugo \
+            --environment production \
+            --minify \
+            --cleanDestinationDir \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./docs-gen/public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

s2dm-0.16.2/.github/workflows/release.yml

@@ -0,0 +1,225 @@
+name: release
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: 'Dry run - build and create release but do not commit or publish to PyPI'
+        required: false
+        type: boolean
+        default: false
+
+env:
+  ZERO_BASED_VERSIONING: true # set this to false when you want to release v1.0.0
+
+jobs:
+  release:
+    if: github.repository_owner == 'covesa'
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v6
+        with:
+          ssh-key: ${{ secrets.DEPLOY_KEY }}
+          fetch-depth: 0
+
+      - name: setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: sync
+        run: uv sync --frozen
+
+      - name: install git-cliff
+        run: |
+          curl -L https://github.com/orhun/git-cliff/releases/download/v2.9.1/git-cliff-2.9.1-x86_64-unknown-linux-gnu.tar.gz | tar xz
+          sudo mv git-cliff-2.9.1/git-cliff /usr/local/bin/
+
+      - name: determine version bump
+        id: version
+        run: |
+          # Get commits since last tag
+          LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
+          if [ -z "$LAST_TAG" ]; then
+            COMMITS=$(git log --pretty=format:"%s" HEAD)
+          else
+            COMMITS=$(git log --pretty=format:"%s" ${LAST_TAG}..HEAD)
+          fi
+
+          echo "Commits since last tag:"
+          echo "$COMMITS"
+
+          # Determine version bump based on conventional commits
+          MAJOR=false
+          MINOR=false
+          PATCH=false
+
+          while IFS= read -r commit; do
+            echo "Analyzing: $commit"
+            if echo "$commit" | grep -qE "^[a-zA-Z]+(\(.+\))?!:"; then
+              echo "Breaking change detected"
+              MAJOR=true
+            elif echo "$commit" | grep -qE "^feat(\(.+\))?:"; then
+              echo "Feature detected"
+              MINOR=true
+            elif echo "$commit" | grep -qE "^(fix|perf)(\(.+\))?:"; then
+              echo "Fix/perf detected"
+              PATCH=true
+            elif echo "$commit" | grep -qE "BREAKING CHANGE:"; then
+              echo "Breaking change in body detected"
+              MAJOR=true
+            fi
+          done <<< "$COMMITS"
+
+          # Determine bump type (major > minor > patch)
+          # Use minor bump for breaking changes when zero-based versioning is enabled
+          if [ "$MAJOR" = true ]; then
+            if [ "$ZERO_BASED_VERSIONING" = "true" ]; then
+              echo "bump=minor" >> $GITHUB_OUTPUT
+              echo "Version bump: MINOR (zero-based versioning - breaking change)"
+            else
+              echo "bump=major" >> $GITHUB_OUTPUT
+              echo "Version bump: MAJOR"
+            fi
+          elif [ "$MINOR" = true ]; then
+            echo "bump=minor" >> $GITHUB_OUTPUT
+            echo "Version bump: MINOR"
+          elif [ "$PATCH" = true ]; then
+            echo "bump=patch" >> $GITHUB_OUTPUT
+            echo "Version bump: PATCH"
+          else
+            echo "bump=none" >> $GITHUB_OUTPUT
+            echo "No version bump needed"
+          fi
+
+      - name: bump version and update changelog
+        if: steps.version.outputs.bump != 'none'
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+
+          # Bump version without creating a tag or commit (since commit=false in .bumpversion.toml)
+          uv run bump-my-version bump ${{ steps.version.outputs.bump }} --no-tag --no-commit
+
+          # Get the new version from .bumpversion.toml
+          NEW_VERSION="v$(grep -E '^current_version = ' .bumpversion.toml | cut -d'"' -f2)"
+          echo "NEW_VERSION=${NEW_VERSION}" >> $GITHUB_ENV
+
+          # Generate changelog with git-cliff for the changes since last tag
+          LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
+          if [ -z "$LAST_TAG" ]; then
+            CHANGELOG=$(git-cliff --latest --strip=header)
+          else
+            CHANGELOG=$(git-cliff ${LAST_TAG}..HEAD --strip=header)
+          fi
+
+          CHANGELOG=$(echo "$CHANGELOG" | sed "s/\[unreleased\]/[${NEW_VERSION#v}] - $(date +%Y-%m-%d)/i")
+
+          # Update CHANGELOG.md - insert new version above the previous version
+          # Create temporary file with the new changelog entry
+          echo "${CHANGELOG}" > temp_changelog.md
+          echo "" >> temp_changelog.md
+
+          # Insert the new changelog entry after the header (line 7) and before the first version entry
+          head -n 7 CHANGELOG.md > updated_changelog.md
+          cat temp_changelog.md >> updated_changelog.md
+          tail -n +8 CHANGELOG.md >> updated_changelog.md
+          mv updated_changelog.md CHANGELOG.md
+          rm temp_changelog.md
+
+      - name: build package
+        if: steps.version.outputs.bump != 'none'
+        run: |
+          uv build
+
+      - name: verify build
+        if: steps.version.outputs.bump != 'none'
+        run: |
+          # Verify the build artifacts exist
+          ls -la dist/
+          echo "Build artifacts:"
+          ls dist/
+
+          # Test that the version can be imported and matches
+          uv pip install dist/*.whl --force-reinstall
+          PACKAGE_VERSION=$(uv run python -c "import s2dm; print(s2dm.__version__)")
+          EXPECTED_VERSION=$(grep -E '^current_version = ' .bumpversion.toml | cut -d'"' -f2)
+
+          echo "Package version: $PACKAGE_VERSION"
+          echo "Expected version: $EXPECTED_VERSION"
+
+          if [ "$PACKAGE_VERSION" != "$EXPECTED_VERSION" ]; then
+            echo "ERROR: Version mismatch!"
+            exit 1
+          fi
+
+          echo "✓ Build verification successful"
+
+      - name: commit and tag
+        if: steps.version.outputs.bump != 'none' && (github.event.inputs.dry_run != 'true')
+        run: |
+          # Stage all changes (version files and changelog)
+          git add .bumpversion.toml src/s2dm/__init__.py tests/test_s2dm.py CHANGELOG.md
+          git commit -m "chore: release ${NEW_VERSION}
+
+          - Bump version to ${NEW_VERSION#v}
+          - Update CHANGELOG.md"
+
+          # Create the tag on this commit
+          git tag ${NEW_VERSION}
+
+      - name: push changes
+        if: steps.version.outputs.bump != 'none' && (github.event.inputs.dry_run != 'true')
+        run: |
+          git push origin ${{ github.ref_name }} --tags
+
+      - name: create release
+        if: steps.version.outputs.bump != 'none' && (github.event.inputs.dry_run != 'true')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Generate changelog with git-cliff
+          LAST_TAG=$(git tag --sort=-version:refname | sed -n '2p')
+          if [ -z "$LAST_TAG" ]; then
+            CHANGELOG=$(git-cliff --latest --strip=header)
+          else
+            CHANGELOG=$(git-cliff ${LAST_TAG}..${NEW_VERSION} --strip=header)
+          fi
+
+          # Create GitHub release
+          gh release create ${NEW_VERSION} \
+            --title "${NEW_VERSION}" \
+            --notes "## Changes
+
+          ${CHANGELOG}"
+
+      - name: dry run summary
+        if: steps.version.outputs.bump != 'none' && github.event.inputs.dry_run == 'true'
+        run: |
+          echo "DRY RUN MODE"
+          echo "============================================"
+          echo "The following would be released:"
+          echo "  Version: ${NEW_VERSION}"
+          echo "  Package version: $(uv run python -c 'import s2dm; print(s2dm.__version__)')"
+          echo ""
+          echo "Build artifacts:"
+          ls -lh dist/
+          echo ""
+          echo "Skipped steps:"
+          echo " Git commit and tag"
+          echo " Push to repository"
+          echo " GitHub release creation"
+          echo " Publish to PyPI"
+
+      - name: publish to pypi
+        if: steps.version.outputs.bump != 'none' && (github.event.inputs.dry_run != 'true')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

s2dm-0.16.2/.gitignore

@@ -0,0 +1,184 @@
+# macOS-specific files
+*.DS_Store
+
+# Node.js dependencies and build artifacts
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.npm
+.eslintcache
+.stylelintcache
+
+# Hugo build artifacts
+public/
+.hugo_build.lock
+hugo_stats.json
+resources/_gen/
+docs-gen/resources/_gen/
+
+# Local configuration files
+.envrc
+.vscode
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.cursor/

s2dm-0.16.2/.gitlint

@@ -0,0 +1,31 @@
+[general]
+
+# Ignore rules, reference them by id or name (comma-separated)
+
+ignore=B6
+
+# Use search semantics for regex matching
+
+regex-style-search=True
+
+# Enable specific community contributed rules
+
+contrib=contrib-title-conventional-commits,CC1
+
+# Set the extra-path where gitlint will search for user defined rules
+
+# extra-path=./gitlint_rules/my_rules.py
+
+### Configuring rules ###
+
+[title-max-length]
+line-length=100
+
+[title-min-length]
+min-length=5
+
+# Ignore all rules for GitHub Actions or depdenabot bot commits
+
+[ignore-by-author-name]
+regex=(GitHub Action|^(dependabot\[bot\]|dependabot))
+ignore=all

s2dm-0.16.2/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs-gen/themes/hugo-theme-relearn"]
+	path = docs-gen/themes/hugo-theme-relearn
+	url = https://github.com/McShelby/hugo-theme-relearn.git

s2dm-0.16.2/.migration/.bumpversion.toml

@@ -0,0 +1,18 @@
+[tool.bumpversion]
+ current_version = "0.0.0"
+ parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+ serialize = ["{major}.{minor}.{patch}"]
+ search = "{current_version}"
+ replace = "{new_version}"
+ regex = false
+ ignore_missing_version = false
+ ignore_missing_files = false
+ tag = true
+ sign_tags = false
+ tag_name = "v{new_version}"
+ tag_message = "Bump version: {current_version} → {new_version}"
+ allow_dirty = false
+ commit = true
+ message = "chore: bump version {current_version} → {new_version}"
+ moveable_tags = []
+ commit_args = ""

s2dm-0.16.2/.migration/docs/modeling-guide.md

@@ -0,0 +1 @@
+# Modeling Guide