magpylib-studio 0.1.0__tar.gz

magpylib_studio-0.1.0/.github/workflows/cd.yml

@@ -0,0 +1,78 @@
+# Publishes the magpylib_studio engine to PyPI. Needs the same two things set
+# up on the account side before the publish job can succeed: a PyPI Trusted
+# Publisher for "magpylib-studio" linked to this repo/workflow/environment,
+# and a GitHub environment named "pypi" here, restricted to tags matching v*.
+#
+# Triggered directly by the `v*` tag push, the same as release.yml — NOT by
+# that workflow's release being published, and not by `workflow_run` either.
+# Tried first: release.yml creates its release with the default GITHUB_TOKEN,
+# and GitHub deliberately does not let a GITHUB_TOKEN-authored event trigger
+# further workflows (or every push could chain into itself). `workflow_run`
+# would dodge that, but then runs in the *branch* the workflow file lives on,
+# not the tag — which the `pypi` environment's tag-only rule would then
+# reject. A real tag push is the one trigger that is neither. Consequence:
+# the two workflows no longer share a test run, so `test` below is this one's
+# own gate rather than trusting release.yml's.
+name: CD
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [main]
+    tags: ['v*']
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: 3
+
+jobs:
+  test:
+    name: Engine tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest -q
+
+  dist:
+    name: Distribution build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: hynek/build-and-inspect-python-package@v2
+
+  publish:
+    needs: [test, dist]
+    name: Publish to PyPI
+    environment: pypi
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    runs-on: ubuntu-latest
+    if: github.ref_type == 'tag'
+
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: Packages
+          path: dist
+
+      - name: Generate artifact attestation for sdist and wheel
+        uses: actions/attest-build-provenance@v4.1.0
+        with:
+          subject-path: "dist/*"
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

magpylib_studio-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+# Everything green on a machine that is not the one it was written on.
+#
+# Two jobs because they fail for different reasons: the engine against both
+# magpylib versions (the README claims it works with either, and that claim
+# was only ever checked by hand), and the extension end to end in a real VS
+# Code — which needs the engine installed, since that is what it drives.
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  engine:
+    name: engine (magpylib ${{ matrix.magpylib }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # `released` is what `pip install magpylib-studio` gets anyone;
+        # `property-tree` is the branch that adds the first-class style API.
+        # style_compat.py exists to make both work, so both are tested.
+        magpylib: [released, property-tree]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - run: pip install -e ".[dev]"
+      - name: Switch to the property-tree branch
+        if: matrix.magpylib == 'property-tree'
+        run: pip install "magpylib @ git+https://github.com/magpylib/magpylib@feat/improve-style"
+      - run: python -m pytest -q
+
+  extension:
+    name: extension
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: npm
+          cache-dependency-path: vscode-extension/package-lock.json
+      # The extension spawns `python -m magpylib_studio`; with no .venv here it
+      # falls through to python3 on PATH, which is this one.
+      - run: pip install -e .
+      - name: Install
+        working-directory: vscode-extension
+        run: npm ci
+      - name: Compile, lint and check contributions
+        working-directory: vscode-extension
+        run: npm run compile
+      # VS Code needs a display even headless.
+      - name: Integration tests
+        working-directory: vscode-extension
+        run: xvfb-run -a npm test

magpylib_studio-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,84 @@
+# Tag a version, get an installable .vsix on the release page.
+#
+#     git tag v0.0.1 && git push origin v0.0.1
+#
+# This is deliberately *not* Marketplace publishing. That needs a publisher id
+# on the Marketplace and a PAT in secrets, and — more to the point — the engine
+# on PyPI, so that installing the extension is not followed by "now go and pip
+# install this git URL". Until then a release asset is the honest channel:
+#
+#     code --install-extension magpylib-studio-vscode-0.0.1.vsix
+name: Release
+
+on:
+  push:
+    tags: ['v*']
+  workflow_dispatch:
+
+permissions:
+  contents: write # to create the release and attach the .vsix
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: npm
+          cache-dependency-path: vscode-extension/package-lock.json
+      - run: pip install -e ".[dev]"
+
+      # Shipping an untested build is the one thing a release must not do.
+      - name: Engine tests
+        run: python -m pytest -q
+      - name: Install
+        working-directory: vscode-extension
+        run: npm ci
+      - name: Integration tests
+        working-directory: vscode-extension
+        run: xvfb-run -a npm test
+
+      # package.json's version is what vsce embeds in the .vsix, and it does
+      # not follow the tag on its own — so a v0.1.0 tag would otherwise still
+      # ship a .vsix internally labelled 0.0.1. Marketplace versions can't
+      # carry a pre-release suffix, so a v0.1.0rc1-style tag is left alone
+      # and the .vsix keeps whatever the last real release set.
+      - name: Sync extension version to the release tag
+        working-directory: vscode-extension
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          if [[ "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            npm version "$version" --no-git-tag-version --allow-same-version
+          else
+            echo "::notice::${GITHUB_REF_NAME} is a pre-release tag; leaving package.json version as the last synced release"
+          fi
+
+      # vsce runs vscode:prepublish, which copies the LICENSE in and compiles.
+      - name: Package
+        working-directory: vscode-extension
+        run: npx @vscode/vsce package --out "${{ github.workspace }}/magpylib-studio-${{ github.ref_name }}.vsix"
+
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: magpylib-studio-*.vsix
+          generate_release_notes: true
+          body: |
+            Install into VS Code:
+
+            ```sh
+            code --install-extension magpylib-studio-${{ github.ref_name }}.vsix
+            ```
+
+            The extension is the UI only — it drives a Python engine, which
+            has to be installed separately into an interpreter it can find:
+
+            ```sh
+            pip install "magpylib-studio @ git+https://github.com/magpylib/magpylib-studio.git"
+            ```
+
+            Then set `magpylib-studio.pythonPath` to that interpreter.

magpylib_studio-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+# Copied from the repo root at package time (npm run license) so the VSIX
+# carries it. Not tracked: one licence file, no second copy to drift.
+vscode-extension/LICENSE
+
+.venv/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+*.pyc
+magpylib_studio/_version.py

magpylib_studio-0.1.0/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  // The extension folder used to carry its own recommendation, for the TSLint
+  // plugin — deprecated in 2019 in favour of ESLint, which this repo now has.
+  "recommendations": ["dbaeumer.vscode-eslint", "ms-python.python"]
+}

magpylib_studio-0.1.0/.vscode/launch.json

@@ -0,0 +1,50 @@
+{
+  // F5 from the repo root, which is where both halves live: the engine is a
+  // Python package here, the extension is a folder inside it. There is no
+  // second window to open first — that was an artifact of the only launch
+  // config living in vscode-extension/, and it is gone.
+  //
+  // The host opens `sandbox/` rather than nothing, so that its workspace —
+  // and therefore the extension storage holding the script tab's scene.py —
+  // is the same one every time. See sandbox/README.md.
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "${workspaceFolder}/sandbox",
+        "--extensionDevelopmentPath=${workspaceFolder}/vscode-extension"
+      ],
+      "outFiles": ["${workspaceFolder}/vscode-extension/out/**/*.js"],
+      "preLaunchTask": "npm: compile"
+    },
+    {
+      // Same host, without rebuilding first — for when tsc is already
+      // watching and you just want the window back.
+      "name": "Run Extension (no build)",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "${workspaceFolder}/sandbox",
+        "--extensionDevelopmentPath=${workspaceFolder}/vscode-extension"
+      ],
+      "outFiles": ["${workspaceFolder}/vscode-extension/out/**/*.js"]
+    },
+    {
+      "name": "Extension Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}/vscode-extension",
+        "--extensionTestsPath=${workspaceFolder}/vscode-extension/out/test"
+      ],
+      "outFiles": ["${workspaceFolder}/vscode-extension/out/test/**/*.js"],
+      "preLaunchTask": "npm: compile"
+    }
+  ]
+}

magpylib_studio-0.1.0/.vscode/tasks.json

@@ -0,0 +1,26 @@
+{
+  // "npm: compile" is what the launch config waits for, so F5 never starts a
+  // host on stale JavaScript. It runs tsc *and* the webview script check, so
+  // a panel that cannot parse fails here rather than showing up blank.
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "compile",
+      "path": "vscode-extension",
+      "group": "build",
+      "problemMatcher": ["$tsc"],
+      "label": "npm: compile",
+      "detail": "tsc -p ./ && node harness/check-webview-scripts.js"
+    },
+    {
+      "type": "npm",
+      "script": "watch",
+      "path": "vscode-extension",
+      "group": "build",
+      "isBackground": true,
+      "problemMatcher": ["$tsc-watch"],
+      "label": "npm: watch"
+    }
+  ]
+}