Release v0.8.2

.devcontainer/Dockerfile

@@ -0,0 +1,13 @@
+FROM mcr.microsoft.com/devcontainers/base:ubuntu
+
+ARG PIXI_VERSION=v0.68.0
+
+RUN curl -L -o /usr/local/bin/pixi -fsSL --compressed "https://github.com/prefix-dev/pixi/releases/download/${PIXI_VERSION}/pixi-$(uname -m)-unknown-linux-musl" \
+    && chmod +x /usr/local/bin/pixi \
+    && pixi info
+
+# set some user and workdir settings to work nicely with vscode
+USER vscode
+WORKDIR /home/vscode
+
+RUN echo 'eval "$(pixi completion -s bash)"' >> /home/vscode/.bashrc

.devcontainer/devcontainer-lock.json

@@ -0,0 +1,14 @@
+{
+  "features": {
+    "ghcr.io/devcontainers-community/features/direnv": {
+      "version": "1.0.0",
+      "resolved": "ghcr.io/devcontainers-community/features/direnv@sha256:e0266877bb3935f243eaf70b3192182170f4f8c5cd86108e2509de2eff082ef5",
+      "integrity": "sha256:e0266877bb3935f243eaf70b3192182170f4f8c5cd86108e2509de2eff082ef5"
+    },
+    "ghcr.io/devcontainers-extra/features/prek:1": {
+      "version": "1.0.0",
+      "resolved": "ghcr.io/devcontainers-extra/features/prek@sha256:eb55e266252d8560cf726f27c5675e397bb833067a21428c50b273a59842f649",
+      "integrity": "sha256:eb55e266252d8560cf726f27c5675e397bb833067a21428c50b273a59842f649"
+    }
+  }
+}

.devcontainer/devcontainer.json

@@ -0,0 +1,39 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/universal
+{
+  "name": "Soundscapy",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  // "image": "mcr.microsoft.com/devcontainers/base:jammy"
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "ruff.importStrategy": "useBundled",
+        "git.requireGitUserConfig": false
+      },
+      "extensions": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "GitHub.copilot",
+        "renan-r-santos.pixi-code",
+        "tamasfe.even-better-toml",
+        "ms-toolsai.jupyter",
+        "yzhang.markdown-all-in-one",
+        "meta.pyrefly",
+        "eamodio.gitlens"
+      ]
+    }
+  },
+  "mounts": [
+    "source=${localWorkspaceFolderBasename}-pixi,target=${containerWorkspaceFolder}/.pixi,type=volume"
+  ],
+  "postCreateCommand": "sudo chown vscode .pixi && direnv allow . && pixi install",
+  "features": {
+    // "ghcr.io/devcontainers-community/features/direnv": {},
+    "ghcr.io/devcontainers-community/features/direnv:1": {},
+    "ghcr.io/devcontainers-extra/features/prek:1": {}
+  }
+}

.envrc

@@ -0,0 +1,5 @@
+export UV_PUBLISH_TOKEN=$(cat .secrets/pypi-token)
+export PREFIX_API_KEY=$(cat .secrets/prefix-api-key)
+
+# watch_file pixi.lock
+eval "$(pixi shell-hook)"

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

.github/workflows/docs.yml

@@ -2,36 +2,50 @@ name: Documentation
 
 on:
   workflow_call:
-    outputs:
-      docs-pass:
-        description: "Indicates if documentation build passed"
-        value: ${{ github.event.inputs.docs-pass }}
   push:
     branches:
       - main
   pull_request:
 
 jobs:
-  docs:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
 
-      - name: Cache tox
-        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.4
         with:
-          path: .tox
-          key: tox-${{ hashFiles('pyproject.toml') }}
+          pixi-version: v0.68.0
+          cache: true
+          # auth-host: prefix.dev
+          # auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
+          frozen: true
+          environments: "docs"
+
+      - name: Build Zensical documentation with pixi
+        run: pixi run docs-build
 
-      - name: Set up Python
-        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5
+      - name: Upload built docs as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
         with:
-          python-version: "3.x"
-          cache: "pip"
-          cache-dependency-path: "pyproject.toml"
+          path: site
 
-      - name: Install tox
-        run: python -m pip install tox
-      - name: Build HTML documentation with tox
-        run: tox -e docs
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name != 'pull_request'
+    steps:
+      - name: Deploy to Github Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

.github/workflows/linting.yml

@@ -1,33 +1,28 @@
-name: Linting
-
+name: Prek checks
 on:
   push:
-    branches:
-      - main
+    branches: [main]
   pull_request:
+    branches: [main, dev]
 
 jobs:
-  linting:
+  prek:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-
-      - name: Cache pre-commit
-        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
         with:
-          path: ~/.cache/pre-commit
-          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+          fetch-depth: 0
 
-      - name: Set up python
-        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.4
         with:
-          python-version: "3.x"
-          cache: pip
-          cache-dependency-path: pyproject.toml
-
-      - name: Install dependencies
-        run: python -m pip install pre-commit
+          pixi-version: v0.68.0
+          cache: true
+          # auth-host: prefix.dev
+          # auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
+          frozen: true
+          environments: "default"
 
-      - name: Run pre-commit
-        run: pre-commit run --all-files --color always --verbose
+      - name: Run Prek checks
+        uses: j178/prek-action@v2

.github/workflows/release.yml

@@ -0,0 +1,155 @@
+name: Release
+
+# Triggered by merges to main. Publishes to PyPI and prefix.dev/sonic-forge
+# and creates a GitHub release + git tag when pyproject.toml contains a clean
+# version number (no .dev / rc / a / b suffix) and that tag doesn't exist yet.
+#
+# If the version was published to PyPI manually without a tag, the publish
+# step will fail and print instructions for creating the tag manually.
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "**.md"
+  workflow_dispatch:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.ver.outputs.version }}
+      release: ${{ steps.ver.outputs.release }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Read version and check release status
+        id: ver
+        run: |
+          VERSION=$(grep '^version = ' pyproject.toml | sed 's/version = "//;s/"//')
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+
+          # Pre-release version (has .dev, rc, a, b suffix) — skip
+          if ! echo "$VERSION" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+$'; then
+            echo "Pre-release version ${VERSION} — skipping release."
+            echo "release=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          # Tag already exists — already released (possibly manually)
+          git fetch --tags
+          if git ls-remote --tags origin "refs/tags/v${VERSION}" | grep -q .; then
+            echo "Tag v${VERSION} already exists — skipping release."
+            echo "release=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          echo "Clean version ${VERSION} with no existing tag — will release."
+          echo "release=true" >> "$GITHUB_OUTPUT"
+
+  tests-pass:
+    needs: check
+    if: needs.check.outputs.release == 'true'
+    uses: ./.github/workflows/test.yml
+
+  docs-pass:
+    needs: check
+    if: needs.check.outputs.release == 'true'
+    uses: ./.github/workflows/docs.yml
+
+  build:
+    name: Build PyPI wheel and sdist
+    needs: check
+    if: needs.check.outputs.release == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.7.2"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-conda:
+    name: Publish to prefix.dev/sonic-forge
+    needs: check
+    if: needs.check.outputs.release == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: prefix-dev/setup-pixi@v0.9.5
+        with:
+          pixi-version: v0.68.0
+          environments: default
+          cache: true
+          auth-host: prefix.dev
+          auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
+
+      - name: Build and publish conda package
+        run: pixi run publish-conda
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [check, build, tests-pass, docs-pass]
+    if: needs.check.outputs.release == 'true'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Publish failed — manual tag needed
+        if: failure()
+        run: |
+          echo "::error::PyPI publish failed for soundscapy ${{ needs.check.outputs.version }}."
+          echo "::error::If already published manually, create the tag: git tag v${{ needs.check.outputs.version }} && git push origin v${{ needs.check.outputs.version }}"
+
+  tag-and-release:
+    name: Tag and create GitHub release
+    needs: [check, publish-pypi, publish-conda]
+    if: needs.check.outputs.release == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Pull latest main
+        run: git pull origin main
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create git tag and GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ needs.check.outputs.version }}
+        run: |
+          git tag "v${VERSION}"
+          git push origin "v${VERSION}"
+          gh release create "v${VERSION}" dist/* \
+            --title "v${VERSION}" \
+            --generate-notes