de-shell 0.2.0__py3-none-any.whl

de_shell-0.2.0.dist-info/METADATA

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: de-shell
+Version: 0.2.0
+Summary: The Electron + Python desktop-app shell Direct Electron's apps (SpyDE, Ground Crew, Autopilot) are assembled from
+Author-email: Carter Francis <cartsfrancis@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/CSSFrancis/de-shell
+Project-URL: Repository, https://github.com/CSSFrancis/de-shell
+Project-URL: Issues, https://github.com/CSSFrancis/de-shell/issues
+Project-URL: Changelog, https://github.com/CSSFrancis/de-shell/blob/main/CHANGELOG.md
+Keywords: electron,desktop,anyplotlib,electron-microscopy,direct-electron
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: JavaScript
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: anyplotlib>=0.7.3
+Requires-Dist: pyyaml
+Provides-Extra: tests
+Requires-Dist: pytest>=3.6; extra == "tests"
+Requires-Dist: pytest-timeout; extra == "tests"
+Dynamic: license-file
+
+# DE Shell
+
+[![PyPI](https://img.shields.io/pypi/v/de-shell.svg)](https://pypi.org/project/de-shell/)
+[![CI](https://github.com/CSSFrancis/de-shell/actions/workflows/ci.yml/badge.svg)](https://github.com/CSSFrancis/de-shell/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+The substrate Direct Electron's desktop apps are assembled from: **SpyDE**
+(offline analysis), **Ground Crew** (manual camera control) and **Autopilot**
+(automated acquisition). Each app is an Electron window over a Python
+sidecar, and everything the three have in common lives here — the
+Python↔JS message pipe, the window and its menus, the figure bridge over
+[anyplotlib](https://pypi.org/project/anyplotlib/), the sidecar process
+manager and its Python environment, the updater, the problem reporter, the
+Playwright harness.
+
+It contains **no domain logic**. No detectors, no microscopes, no signal
+types, no analysis. `tests/test_boundary.py` enforces that in a clean
+subprocess: the shell must stay installable without the science stack, so
+the live in-memory apps never acquire it transitively.
+
+```bash
+pip install de-shell
+```
+
+## One package
+
+The shell is **one pip package**, and the TypeScript rides inside the wheel:
+
+```
+pyproject.toml          the package: de-shell
+de_shell/               app loop, session base, actions, IPC, figures, compute, logging
+de_shell/js/            the TypeScript half, one folder per Electron target
+  main/                 Electron main: window, sidecar + stdout demuxer, python env, updater, reports
+  preload/              the contextBridge surface (exposeShellBridge)
+  renderer/             React: figure bridge, FigureFrame, the chrome slice of state
+  testing/              the Playwright harness (launchApp)
+tests/                  the Python suite (incl. the boundary test)
+package.json            DEV ONLY: typechecks and unit-tests de_shell/js; nothing is published to npm
+```
+
+The JavaScript that speaks the sidecar protocol ships in the same artifact
+as the Python that speaks it. One `pip install -U de-shell` moves both, and
+an app cannot end up with the two halves at different versions. The
+TypeScript is shipped as **source** and compiled by the consuming app's
+bundler, so there is no build step here and an editable install is
+live-editable from the app.
+
+## Consuming it
+
+**Python** — an ordinary dependency:
+
+```toml
+dependencies = ["de-shell>=0.2,<0.3"]
+```
+
+For hacking on the shell and an app at once, a sibling checkout as an
+editable path source (uv) or `pip install -e ../de-shell` overlays it.
+
+**Electron** — ask the installed package where its TypeScript is and link
+it into the project at a fixed path, then alias and `paths` through the link:
+
+```
+python -m de_shell.js        # prints …/de_shell/js
+```
+
+Autopilot's `electron/scripts/shell-link.mjs` is the reference: it makes
+`electron/shell` a junction (a symlink off Windows) to that folder, runs from
+npm's postinstall and from the vite config on every build, and re-points a
+stale link rather than trusting it. With it in place:
+
+```ts
+// electron.vite.config.ts
+const shell = ensureShellLink(__dirname)
+resolve: { alias: { '@de/shell-main': resolve(shell, 'main', 'index.ts') },
+           dedupe: ['react', 'react-dom'] }
+```
+
+```json
+// tsconfig.json
+"noEmit": true, "allowImportingTsExtensions": true,
+"paths": { "@de/shell-main": ["./shell/main/index.ts"], … }
+```
+
+`dedupe` matters: an editable checkout carries its own `node_modules` for
+its typecheck, and without it the renderer would bundle a second React. The
+peer dependencies — react, electron, electron-updater, @playwright/test —
+are the app's to declare; every app already does. The e2e specs take the
+harness from `shell/testing/harness.cjs`.
+
+Autopilot and SpyDE (on its `chore/de-shell-split` branch) are wired this
+way; Ground Crew still carries a copy under its `packages/` and is next.
+
+## Developing it
+
+```bash
+uv sync --extra tests && uv run pytest        # the Python suite
+ELECTRON_SKIP_BINARY_DOWNLOAD=1 npm install   # types only; drop the variable to run Electron
+npm run typecheck                             # every target, tests included, under tsconfig.json
+npm run test:unit                             # node --test over de_shell/js
+uv build                                      # the wheel — CI checks it carries de_shell/js
+```
+
+The unit tests run under Node's native type stripping, which resolves
+relative imports literally — so shell modules import their siblings with the
+`.ts` extension spelled out, and every tsconfig that compiles them (this one
+and each app's) sets `allowImportingTsExtensions`.
+
+CI (`.github/workflows/ci.yml`) runs the Python suite on Linux, Windows and
+macOS at the oldest and newest supported Python, the typecheck and unit
+tests, and builds the wheel and checks what it carries.
+
+## Releasing
+
+The version is written once, in `de_shell/__init__.py`. To release:
+
+1. Bump `__version__`, move the `CHANGELOG.md` entries under the new version.
+2. Commit, tag `vX.Y.Z`, push the tag.
+
+`.github/workflows/publish.yml` builds the distributions, refuses a tag that
+does not match `__version__`, and uploads to PyPI through trusted publishing
+— on pypi.org the project must list this repository, that workflow file and
+the `pypi` environment as a publisher (no token lives in the repo). Semver,
+with the 0.x caveat: a breaking change to the sidecar protocol bumps the
+minor, and the apps pin `>=0.x,<0.(x+1)`.
+
+## Provenance
+
+Merged 2026-09-02 from the three vendored copies, three-way against the
+SpyDE commit the app copies were taken from:
+
+* SpyDE `main` @ 1f3331d (v0.4.3): the problem reporter (`errorReport`,
+  `problemLog`, `sentryEnvelope`), `recentBackendOutput`, the workspace-member
+  wheels in `pythonEnv`, the update handoff that tree-kills the sidecar first,
+  `run_on_worker`'s in-flight count and `ComputeHandle` in `lifecycle.py`.
+* Autopilot @ 7f0651e: the sidecar's close handler forgets only ITS child, the
+  malformed-message report, the figure/stream fixes ported from the siblings,
+  the renderer state and FigureFrame changes.
+* Ground Crew `main` @ 26e853a: the spawn-error trap and 5 s tree-kill grace,
+  the resolved `uv` path, the open-directory dialog, `_pin_tile_band` (black
+  panes on large stills), JSON emit that never writes bare `NaN`, the harness
+  hardening, and the unit tests for all of it.
+
+Not yet included: Ground Crew's `dev/instrument-actions` shell deltas
+(`stdoutDemux`, `sizeReporter`, the `frameBytes` transport) — they ride a
+branch that has not merged.
+
+## Rules
+
+* **Nothing here mentions a detector, a signal type, or an analysis.** If
+  extracting something into the shell requires touching one, the boundary is
+  in the wrong place.
+* **The Python side stays tiny.** Every dependency added is one all three
+  apps install: numpy, anyplotlib, pyyaml, and that is the list.
+* **The protocol is the contract.** `PLOTAPP:` JSON lines and `PLOTBIN:`
+  binary frames over the sidecar's stdio. Both halves of it live in this one
+  package on purpose; keep it that way.
+* **LF line endings**, enforced by `.gitattributes`.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

de_shell-0.2.0.dist-info/RECORD

@@ -0,0 +1,57 @@
+de_shell/__init__.py,sha256=XVlMUM-wy0M_wGn0T9vnuebiPu-SJpF7LvraZqVkwEY,1300
+de_shell/app.py,sha256=XQXMeLekItBSV7QRV3ZDsWdXHHe47CX2e1T_3B2cegA,6515
+de_shell/compute.py,sha256=lg2V19HDdgvfFJm-30-DkLbcqQuzm9KaJmdsfXZ1o9s,3955
+de_shell/debug_flags.py,sha256=umr2gLdWoPg4OEmN6nzzfPugRPpPEJSYl_90TKp8H4s,2993
+de_shell/ipc.py,sha256=FX53c2tQAQQDX3xENWLx1RFDQVlL1u06jeZ2kdyEO9I,9445
+de_shell/log_stream.py,sha256=mf5hAuOzZbjjZF2i8ecjlrZ_IpHT0yyNK6JRwhZav7s,7543
+de_shell/process_guard.py,sha256=-jN6pYUwTIr2MSZbZ5IaL6vs5EADg9h1OG9tj5rqYu4,8533
+de_shell/session.py,sha256=oiHRshmmfqEnG6afhS5ZmC2XhSnqZUmI3Qk7a0ABIkE,9765
+de_shell/timing.py,sha256=SRVf6FZvN_5TVJJLLrVMDchigUdFtY9ePQxaMn7Flig,1070
+de_shell/actions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+de_shell/actions/context.py,sha256=xQbKMCxCM_bYJ-8-cbI7sZv3OVQYiOGWf9EDURdK7gU,2626
+de_shell/actions/figure_registry.py,sha256=8j8KbLXmPARgmSiLdKEBd1wEIef-pVzN1wfTvTGvwwM,2047
+de_shell/actions/lifecycle.py,sha256=KzsCbvMjjEEeuC7iXX--lllXM_XtMHsv3XGNxxeDmEA,11782
+de_shell/actions/registry.py,sha256=CV3jJEecUM8Et1SGSZPlS_-XH8fD3hhXoQe_tZHKJYk,6263
+de_shell/actions/wizard.py,sha256=jT_43aWLFFuRTHGgYilnGQVDuNuFJoBHD8h6vc6G4XI,5294
+de_shell/js/__init__.py,sha256=A8nHUYp7wiChI88ihhEj0t6J2MF62W_vvS8Iu6ww61A,1713
+de_shell/js/__main__.py,sha256=erFsK0Mnzj9td7fQUx-_QmBh9Q4HNW5JEC9JDA_0L6w,117
+de_shell/js/package.json,sha256=kjMBaXcVWFx6Z5_IX8K6Zf7qWDCUIsq9lSRC-70qCno,229
+de_shell/js/main/backendProcess.test.ts,sha256=xbgSNhw52jlD-OTR1NoKbCl41LQIgI8KFN8nVUJxhVM,2545
+de_shell/js/main/backendProcess.ts,sha256=-FK_cH_cq6A5Enz1Yu_FzHMXwPPt5rUhFo5wMVNI5Os,14961
+de_shell/js/main/config.ts,sha256=8_xfaoWuPwIT4DJEdSFWKQq0ctpsMY-SoNAe2qLt4fI,2077
+de_shell/js/main/dialogs.ts,sha256=91KlIWDTiARx58_P1WIjp9y49b4iJUKuLH9iEVxd37o,2692
+de_shell/js/main/envProgress.ts,sha256=rDHpSiZaBnbXOXqoy3i3IeF75UMzZCjOglK4j67bUS0,5189
+de_shell/js/main/errorReport.ts,sha256=vti7YZ55VS63BXQ_bEC6rM-VrWCPWusPleu_AiHRvOA,9918
+de_shell/js/main/index.ts,sha256=dqa8YK5KXnwWwZqfRbbJJ8sZHRq2iEmbUimtOWoHceM,2122
+de_shell/js/main/problemLog.ts,sha256=96JMKEKBa_W9BWfUf9PVwGeMgsrMM5xJGa0SBma0-SM,1753
+de_shell/js/main/pythonEnv.test.ts,sha256=UCAZ5a8jvBbPZN-dLYSmXcfjLd7R5T1AlyTcaMmQqWc,4456
+de_shell/js/main/pythonEnv.ts,sha256=Bx_8MoIHLto9UIu8swXrv4YwB13I-T-5MlbGYxgXpzE,19268
+de_shell/js/main/sentryEnvelope.test.ts,sha256=nfmeyQL_8awCOh57GsjHxBLUkJW29PnuevZTwsZb6K0,4204
+de_shell/js/main/sentryEnvelope.ts,sha256=tAvbrm7CHcwkzIx8Vzx5-PjeXgMhXJWIKLUPRGuJT9s,3646
+de_shell/js/main/updater.ts,sha256=Pc2JZjuAIn6HbCYusc-NqhhbsSOO0xOIjTlz3dLkSKE,14406
+de_shell/js/main/updaterErrors.test.ts,sha256=sF0nIjl2VPunIdV35yHZuCPunAgA_0vqjP-F4abgMIA,4545
+de_shell/js/main/updaterErrors.ts,sha256=Q1fdDwG-UjiZjYpVtLsaeM_PaPAoK_i2xE8yMz67ois,3558
+de_shell/js/main/window.ts,sha256=d63Icr7hb71IF8bJJIV5_7-cjr278-Dhw2idXU1HigY,5904
+de_shell/js/preload/index.ts,sha256=OI2DtJd5GXo676ryfabX4wyANIKzRG-arYTFLMW5Xpw,5620
+de_shell/js/renderer/FigureFrame.tsx,sha256=kE3VsqTW9wAEMY7ASvFyezQlK9hK-qjI_tuMJRmHesM,3760
+de_shell/js/renderer/figureBridge.react.ts,sha256=C7yHfZSqeUpg45-dP-mqqv007d9vs2rfc_4EpfoD8z0,2336
+de_shell/js/renderer/figureBridge.test.ts,sha256=64qOd5Ejs7TAp-wW-2Z0Mf_D4Whi3S52qhCMzx0TDfQ,7023
+de_shell/js/renderer/figureBridge.ts,sha256=ck6QSNk0b_BbHlgd0BjkAdzvN3V2N3PjcoUV29WKj9U,6954
+de_shell/js/renderer/index.ts,sha256=zrySGnAQWv-1BlPRVUg447hes_KeOlfhqH1qlUhNTY4,1362
+de_shell/js/renderer/protocol.ts,sha256=CBjx2QdYhnwV50Re6_3WALIgySuXSHy2mJZ64Q5jLao,4787
+de_shell/js/renderer/shellState.test.ts,sha256=tNDhK9YImBGmXh58hyFcztPpGWr8pn2AbgtF-TytA6E,8124
+de_shell/js/renderer/shellState.ts,sha256=gS4VYvANMqH5eCKGRwFINpF5a_uLRBzqWbUBMZnYCBk,11012
+de_shell/js/testing/harness.cjs,sha256=Jc0Iu4X9S949y5liFpP7QPT-DXyKxhJ3MkDkwpt043Q,9750
+de_shell/js/testing/harness.test.cjs,sha256=ClMYpMIEyE-0qOxnKDntoiLWKht8F9sjbDO_CFw-RoE,2660
+de_shell/plotting/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+de_shell/plotting/colormaps.py,sha256=spjwz3Z0BuDZGZF2FSiZPx426ZSfUsB9kShLXVx07qs,1104
+de_shell/plotting/figure.py,sha256=bH7LwnBQxEP8raXA59y6gsDbmYW5r7gC91xGqsn0GqQ,27229
+de_shell/plotting/stream.py,sha256=dfhukXDKvCosU8kLg4WBQhLAOJPereCv9NrZ8Mi8pIE,7193
+de_shell/plotting/selectors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+de_shell/plotting/selectors/utils.py,sha256=k2jDvPvbhuxn9Fj_1j88xCxno28fcZm0xvxa-YKsiz4,825
+de_shell/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+de_shell-0.2.0.dist-info/licenses/LICENSE,sha256=loY7HtU18sSR16cVKwg-SThASzEYIuHBL0DqxLldkKA,1072
+de_shell-0.2.0.dist-info/METADATA,sha256=Im98ebQQqEz5B6SVDsFf5GzbhJ2mwPMhSPWEk5O7Y2o,8776
+de_shell-0.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+de_shell-0.2.0.dist-info/top_level.txt,sha256=X3wBU8swYcsGGP4_1mEaMJqTW9Ij2HjruuyOfQxwvKc,9
+de_shell-0.2.0.dist-info/RECORD,,

de_shell-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

de_shell-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Direct Electron
+
+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.

de_shell-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+de_shell