inklet 3.0.0__tar.gz → 4.0.0.dev1__tar.gz

inklet-4.0.0.dev1/.gitattributes

@@ -0,0 +1,4 @@
+# PDB records use fixed-width, space-padded columns.
+*.pdb whitespace=-blank-at-eol
+# Keep example source hashes stable across platforms.
+examples/data/general-plots/*.csv text eol=lf

inklet-4.0.0.dev1/.github/workflows/checks.yml

@@ -0,0 +1,233 @@
+name: Release checks
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: checks-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  figures:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 25
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.12'
+      - name: Install fonts and independent PDF renderer
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y fonts-dejavu-core fonts-dejavu-extra fonts-noto-core fonts-liberation fonts-urw-base35 poppler-utils
+          pdftoppm -v
+      - name: Install the reviewed visual browser
+        env:
+          CHROME_VERSION: '145.0.7632.45'
+          CHROME_SHA256: 6aed53fe777ca9a58a680b848a80022300566fb902424291e054984a784c73a2
+        run: |
+          curl --fail --location --retry 3 "https://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_${CHROME_VERSION}-1_amd64.deb" --output "$RUNNER_TEMP/chrome.deb"
+          printf '%s  %s\n' "$CHROME_SHA256" "$RUNNER_TEMP/chrome.deb" | sha256sum --check
+          dpkg-deb -x "$RUNNER_TEMP/chrome.deb" "$RUNNER_TEMP/visual-browser"
+          mkdir -p "$RUNNER_TEMP/visual-browser/bin"
+          ln -s ../opt/google/chrome/google-chrome "$RUNNER_TEMP/visual-browser/bin/google-chrome"
+          echo "$RUNNER_TEMP/visual-browser/bin" >> "$GITHUB_PATH"
+          "$RUNNER_TEMP/visual-browser/bin/google-chrome" --version
+      - name: Install locked test dependencies
+        run: |
+          uv venv
+          uv pip install -r requirements-ci.txt -e .
+          .venv/bin/inklet doctor
+      - name: Unit and integration tests
+        run: .venv/bin/python -m pytest -q --junitxml=out/tests.xml
+      - name: Generated API documentation
+        run: .venv/bin/python tools/gen_api.py --check
+      - name: Build documentation with strict link validation
+        run: |
+          uv pip install -r requirements-docs.txt
+          .venv/bin/python -m mkdocs build --strict
+          .venv/bin/python -m pytest -q tests/test_docs_site.py
+      - name: Build the v2.5 publication review
+        run: .venv/bin/inklet build examples/v25_document.py --output out/v25 --name document
+      - name: Build the preset comparison gallery
+        run: .venv/bin/python tools/preset_gallery.py --output out/presets
+      - name: Common CSV plotting example
+        run: |
+          .venv/bin/python examples/general_plots.py --output out/general-plots
+          .venv/bin/python examples/plot_quality_review.py --output out/plot-quality
+      - name: Experimental selection and revision baseline
+        run: |
+          .venv/bin/python examples/v4/linked_selection.py --output out/v4-linked
+          .venv/bin/python examples/v4/browser_scatter.py --count 3000 --output out/v4-browser
+          .venv/bin/python examples/v4/linked_dashboard.py --output out/v4-dashboard
+          .venv/bin/python examples/v4/faceted_operations.py --output out/v4-facets
+          .venv/bin/python examples/v4/time_series.py --output out/v4-time
+          .venv/bin/python examples/v4/statistical_views.py --output out/v4-statistics
+          .venv/bin/python examples/v4/regional_report.py --render --output out/v4-regional-report
+          .venv/bin/python examples/v4/engineering_report.py --render --output out/v4-engineering
+          .venv/bin/python examples/v4/scientific_report.py --render --output out/v4-scientific
+          .venv/bin/python examples/v4/mesh_fields.py --render --output out/v4-mesh-fields
+          .venv/bin/python examples/v4/contours_streamlines.py --render --output out/v4-contours-streamlines
+          .venv/bin/python examples/v4/regional_analysis.py --output out/v4-regions
+          .venv/bin/python examples/v4/region_shapes.py --output out/v4-region-shapes
+          .venv/bin/python examples/v4/world_population.py --output out/v4-world
+          .venv/bin/python examples/v4/world_population.py --year 2019 --output out/v4-revision
+          .venv/bin/python examples/v4/world_population.py --switchable --output out/v4-switchable
+          .venv/bin/python tools/benchmark_v4.py --repeat 1 --label ci --output out/v4-baseline.json
+      - name: Build the mathematical showcase library
+        run: .venv/bin/python tools/showcase_gallery.py --plots-only --quality preview
+      - name: Coordinated biology figure and data export
+        run: .venv/bin/python examples/biology_panels.py --output out/biology
+      - name: Complete figure visual regressions
+        run: .venv/bin/python tools/visual_check.py --output out/visual
+      - name: Complete figure performance checks
+        run: .venv/bin/python tools/benchmark_v2.py --output out/benchmarks
+      - name: Rendering engine workloads and quality review
+        run: |
+          .venv/bin/python tools/benchmark_engine.py --repeat 1 --output out/engine-benchmark.json
+          .venv/bin/python examples/engine_review.py --output out/engine-review
+      - name: Diagram routing and label review
+        run: |
+          .venv/bin/python tools/benchmark_diagrams.py --repeat 1 --output out/diagram-benchmark.json
+          .venv/bin/python examples/diagram_review.py --output out/diagram-review
+      - name: Dense vector lines and measured axes
+        run: |
+          .venv/bin/python tools/benchmark_lines.py --repeat 1 --output out/line-benchmark.json
+          .venv/bin/python examples/plot_engine_review.py --output out/plot-engine-review
+      - name: Twenty-panel mixed-media stress test
+        run: .venv/bin/python tools/stress20.py --output out/stress20
+      - name: Preserve review artifacts
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: figure-checks
+          path: out/
+          retention-days: 7
+          if-no-files-found: ignore
+
+  tables:
+    name: Table adapters (${{ matrix.dependencies }})
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        dependencies: [minimum, current]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.12'
+      - name: Install current locked adapters
+        if: matrix.dependencies == 'current'
+        run: |
+          uv venv
+          uv pip install -r requirements-tables.txt -e .
+      - name: Install minimum supported adapters
+        if: matrix.dependencies == 'minimum'
+        run: |
+          uv venv
+          uv pip install -e '.[dev]' 'pandas==2.2.0' 'polars==1.0.0' 'numpy==1.26.4'
+      - name: Table contracts and cross-library figure reconstruction
+        run: |
+          .venv/bin/python -m pytest -q tests/test_table_adapters.py tests/test_temporal_adapters.py tests/test_v4_selection.py
+          .venv/bin/python examples/v4/table_inputs.py --backend pandas --output out/pandas
+          .venv/bin/python examples/v4/table_inputs.py --backend polars --state out/pandas/view.json --output out/polars
+          cmp out/pandas/figure.svg out/polars/figure.svg
+          .venv/bin/python examples/v4/table_inputs.py --backend pandas --revised --output out/pandas-revised
+          .venv/bin/python examples/v4/table_inputs.py --backend polars --revised --state out/pandas-revised/view.json --output out/polars-revised
+          cmp out/pandas-revised/figure.svg out/polars-revised/figure.svg
+          .venv/bin/python examples/v4/time_series.py --backend pandas --output out/time-pandas
+          .venv/bin/python examples/v4/time_series.py --backend polars --state out/time-pandas/view.json --output out/time-polars
+          cmp out/time-pandas/figure.svg out/time-polars/figure.svg
+
+  wheel:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    defaults:
+      run:
+        shell: bash
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04]
+        python: ['3.11', '3.12', '3.13']
+        include:
+          - os: windows-2022
+            python: '3.12'
+          - os: macos-14
+            python: '3.12'
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Build and install with core dependencies only
+        run: |
+          uv build --wheel --out-dir out/dist
+          uv run --no-project python tools/check_wheel.py out/dist/inklet-*.whl
+      - name: Install and check optional render extra
+        run: uv run --no-project python tools/check_render_wheel.py out/dist/inklet-*.whl
+
+  blender:
+    name: Blender ${{ matrix.version }} CPU
+    runs-on: ubuntu-24.04
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - version: '4.2.23'
+            series: '4.2'
+            sha256: bea0eb3146be13eae6225409a117b215184f41b7f79e799f97cb3abb8f6dc404
+          - version: '4.5.13'
+            series: '4.5'
+            sha256: da4e69b06b75b9e642d106496c50e7e240218b411d2f6e18271c1d1d819cef91
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.12'
+      - name: Install Blender and test dependencies
+        env:
+          BLENDER_VERSION: ${{ matrix.version }}
+          BLENDER_SERIES: ${{ matrix.series }}
+          BLENDER_SHA256: ${{ matrix.sha256 }}
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libegl1 libxkbcommon0 fonts-dejavu-core fonts-dejavu-extra
+          archive="blender-${BLENDER_VERSION}-linux-x64.tar.xz"
+          curl --fail --location --retry 3 "https://download.blender.org/release/Blender${BLENDER_SERIES}/${archive}" --output "$RUNNER_TEMP/$archive"
+          printf '%s  %s\n' "$BLENDER_SHA256" "$RUNNER_TEMP/$archive" | sha256sum --check
+          tar -xf "$RUNNER_TEMP/$archive" -C "$RUNNER_TEMP"
+          echo "INKLET_BLENDER=$RUNNER_TEMP/blender-${BLENDER_VERSION}-linux-x64/blender" >> "$GITHUB_ENV"
+          uv venv
+          uv pip install -r requirements-ci.txt -e .
+      - name: Require the requested Blender build
+        env:
+          BLENDER_VERSION: ${{ matrix.version }}
+        run: |
+          .venv/bin/python -c 'import os; from inklet.three.blender import find_blender; assert find_blender().release == os.environ["BLENDER_VERSION"]'
+      - name: Complete scenes, passes, projections, annotations and templates
+        run: |
+          .venv/bin/python -m pytest -q tests/test_blend_scene.py tests/test_scene_pass.py tests/test_scene_projection.py tests/test_scene_annotations.py tests/test_scene_templates.py tests/test_render_devices.py tests/test_render_jobs.py --junitxml=out/blender-tests.xml
+      - name: Installed wheel creates and renders all templates
+        run: |
+          uv build --wheel --out-dir out/dist
+          .venv/bin/python tools/check_render_wheel.py out/dist/inklet-*.whl --templates
+      - name: Legacy vector line-art export integrity
+        if: matrix.version == '4.2.23'
+        run: .venv/bin/python -m pytest -q tests/test_three_blender.py
+      - name: Preserve Blender test report
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: blender-${{ matrix.version }}-checks
+          path: out/blender-tests.xml
+          retention-days: 7

inklet-4.0.0.dev1/.github/workflows/publish.yml

@@ -0,0 +1,113 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Published GitHub release tag
+        required: true
+        default: v4.0.0.dev1
+        type: string
+      dry_run:
+        description: Validate release files without uploading to PyPI
+        required: true
+        default: true
+        type: boolean
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pypi-publish
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    if: github.repository == 'Mapika/inklet' && github.ref == 'refs/heads/master'
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    environment:
+      name: pypi
+      url: https://pypi.org/project/inklet/
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.12'
+      - name: Download published release distributions
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          RELEASE_TAG: ${{ inputs.tag }}
+        run: |
+          [[ "$RELEASE_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(\.dev[0-9]+)?$ ]] || {
+            echo 'Expected a stable or development tag such as v3.1.0 or v4.0.0.dev1' >&2
+            exit 1
+          }
+          gh release view "$RELEASE_TAG" --json isDraft,isPrerelease > "$RUNNER_TEMP/release.json"
+          python - <<'PYCODE'
+          import json, os
+          from pathlib import Path
+          release = json.loads((Path(os.environ['RUNNER_TEMP']) / 'release.json').read_text())
+          if release['isDraft']:
+              raise SystemExit('Publish the GitHub release before uploading its assets')
+          if release['isPrerelease'] != ('.dev' in os.environ['RELEASE_TAG']):
+              raise SystemExit('Development tags must be GitHub prereleases; stable tags must not')
+          PYCODE
+          version="${RELEASE_TAG#v}"
+          gh release download "$RELEASE_TAG" --dir dist \
+            --pattern "inklet-${version}-py3-none-any.whl" \
+            --pattern "inklet-${version}.tar.gz" \
+            --pattern SHA256SUMS
+      - name: Verify release checksums and package metadata
+        env:
+          RELEASE_TAG: ${{ inputs.tag }}
+        run: |
+          python - <<'PY'
+          import hashlib
+          import os
+          import tarfile
+          import zipfile
+          from email.parser import BytesParser
+          from pathlib import Path
+
+          dist = Path('dist')
+          version = os.environ['RELEASE_TAG'][1:]
+          expected = {f'inklet-{version}-py3-none-any.whl', f'inklet-{version}.tar.gz'}
+          lines = (dist / 'SHA256SUMS').read_text().splitlines()
+          entries = [line.split() for line in lines]
+          if len(entries) != 2 or any(len(entry) != 2 for entry in entries):
+              raise SystemExit('Expected exactly two release checksums')
+          if {name for _, name in entries} != expected:
+              raise SystemExit('Checksum filenames do not match the requested release')
+          for digest, name in entries:
+              if hashlib.sha256((dist / name).read_bytes()).hexdigest() != digest:
+                  raise SystemExit(f'Checksum mismatch: {name}')
+              print(f'Verified {name}')
+          wheel = dist / f'inklet-{version}-py3-none-any.whl'
+          with zipfile.ZipFile(wheel) as archive:
+              metadata_files = [n for n in archive.namelist() if n.endswith('.dist-info/METADATA')]
+              if len(metadata_files) != 1:
+                  raise SystemExit('Expected exactly one wheel metadata file')
+              wheel_metadata = BytesParser().parsebytes(archive.read(metadata_files[0]))
+          with tarfile.open(dist / f'inklet-{version}.tar.gz') as archive:
+              metadata = archive.extractfile(f'inklet-{version}/PKG-INFO')
+              if metadata is None:
+                  raise SystemExit('Missing source archive metadata')
+              source_metadata = BytesParser().parsebytes(metadata.read())
+          for metadata in (wheel_metadata, source_metadata):
+              if metadata['Name'] != 'inklet' or metadata['Version'] != version:
+                  raise SystemExit('Distribution metadata does not match the requested release')
+          (dist / 'SHA256SUMS').unlink()
+          PY
+          uvx --from twine==7.0.0 twine check --strict dist/*
+      - name: Publish using PyPI Trusted Publishing
+        if: ${{ !inputs.dry_run }}
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          packages-dir: dist/
+      - name: Record dry run
+        if: inputs.dry_run
+        run: echo 'Release files verified. Nothing was uploaded to PyPI.' >> "$GITHUB_STEP_SUMMARY"