shuttlecheck 0.2.1__tar.gz → 0.4.0__tar.gz

{shuttlecheck-0.2.1/shuttlecheck.egg-info → shuttlecheck-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shuttlecheck
-Version: 0.2.1
+Version: 0.4.0
 Summary: Check media filenames, folder structure and deliverables against a written convention. Read-only.
 Author-email: MVRK Systems <hello@mvrk.systems>
 License: Proprietary — free to use, no redistribution
@@ -26,12 +26,15 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: jsonschema>=4.20
+Requires-Dist: xxhash>=3.0
 Requires-Dist: tzdata>=2024.1; sys_platform == "win32"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == "dev"
+Provides-Extra: app
+Requires-Dist: pywebview>=5.0; extra == "app"
 Dynamic: license-file
 
-# ShuttleCheck
+# ShuttleCheck™
 
 **Check media filenames, folder structure and deliverables against a written
 convention.** Nothing in this package renames, moves or deletes anything.
@@ -65,8 +68,8 @@ FIELDS RECOVERED
   {title}        slug        85%  opening-remarks, keynote
 ```
 
-It handles conventions that disagree with themselves — several accepted forms
-per field, optional elements, free-text titles containing the separator —
+It handles conventions that disagree with themselves: several accepted forms
+per field, optional elements, free-text titles containing the separator, all
 because real ones do.
 
 ## Then it tells you what breaks it
@@ -101,14 +104,14 @@ conflated, because a noisy report does not get read.
 | Unicode | Names that compare equal on one platform and not another |
 
 Media inspection uses `ffprobe` when it is on your PATH. When it is not, those
-checks are reported as **skipped** — never as passed. A silent skip is how a
+checks are reported as **skipped**, never as passed. A silent skip is how a
 conformance tool starts lying.
 
 ## For live events, the running order does the work
 
 An event agenda is structured data that exists weeks before anyone turns a
-camera on. Joined against time-of-day timecode, every recording names itself —
-stage, session, speaker, sponsor — with no inference of any kind.
+camera on. Joined against time-of-day timecode, every recording names itself,
+with its stage, session, speaker and sponsor, and no inference of any kind.
 
 It will also tell you when a filename is well-formed and still wrong: `S007`
 recorded during `S011` is a valid shape carrying a false claim, and only the
@@ -129,13 +132,18 @@ No spec to be told about, no account, no connection.
 
 ## What this package will not do
 
-It will not rename, move or delete anything. That boundary is the point: it is
-the command a stranger will run on a live job, because running it cannot cost
-them anything.
+It will not rename, move or delete anything of yours. That boundary is the
+point: it is the command a stranger will run on a live job, because running
+it cannot cost them anything.
 
-Conforming files, the reversible journal, sealing drives and per-vendor specs
-are licensed separately as ShuttleCheck Pro. Asking for one of those commands
-here prints an explanation rather than an error.
+**Sealing is the one exception, and it is free.** `seal` writes an ASC MHL
+hash list and the convention alongside your media, touching none of it. A
+manifest is only worth what the far end can read for nothing, so the half
+that writes one cannot be the paid half.
+
+Conforming files to a convention, and undoing a conform run, are licensed
+separately as ShuttleCheck Pro. Asking for one of those commands here prints
+an explanation rather than an error.
 
 ## Licence
 
@@ -143,3 +151,7 @@ Free to install and use. Not open source: no right to redistribute or modify.
 See <https://mvrk.systems/shuttlecheck>.
 
 Made by [MVRK Systems](https://mvrk.systems).
+
+---
+
+ShuttleCheck™ and DailiesDrop™ are trademarks of MVRK Systems.

{shuttlecheck-0.2.1 → shuttlecheck-0.4.0}/PYPI.md

@@ -1,4 +1,4 @@
-# ShuttleCheck
+# ShuttleCheck™
 
 **Check media filenames, folder structure and deliverables against a written
 convention.** Nothing in this package renames, moves or deletes anything.
@@ -32,8 +32,8 @@ FIELDS RECOVERED
   {title}        slug        85%  opening-remarks, keynote
 ```
 
-It handles conventions that disagree with themselves — several accepted forms
-per field, optional elements, free-text titles containing the separator —
+It handles conventions that disagree with themselves: several accepted forms
+per field, optional elements, free-text titles containing the separator, all
 because real ones do.
 
 ## Then it tells you what breaks it
@@ -68,14 +68,14 @@ conflated, because a noisy report does not get read.
 | Unicode | Names that compare equal on one platform and not another |
 
 Media inspection uses `ffprobe` when it is on your PATH. When it is not, those
-checks are reported as **skipped** — never as passed. A silent skip is how a
+checks are reported as **skipped**, never as passed. A silent skip is how a
 conformance tool starts lying.
 
 ## For live events, the running order does the work
 
 An event agenda is structured data that exists weeks before anyone turns a
-camera on. Joined against time-of-day timecode, every recording names itself —
-stage, session, speaker, sponsor — with no inference of any kind.
+camera on. Joined against time-of-day timecode, every recording names itself,
+with its stage, session, speaker and sponsor, and no inference of any kind.
 
 It will also tell you when a filename is well-formed and still wrong: `S007`
 recorded during `S011` is a valid shape carrying a false claim, and only the
@@ -96,13 +96,18 @@ No spec to be told about, no account, no connection.
 
 ## What this package will not do
 
-It will not rename, move or delete anything. That boundary is the point: it is
-the command a stranger will run on a live job, because running it cannot cost
-them anything.
+It will not rename, move or delete anything of yours. That boundary is the
+point: it is the command a stranger will run on a live job, because running
+it cannot cost them anything.
 
-Conforming files, the reversible journal, sealing drives and per-vendor specs
-are licensed separately as ShuttleCheck Pro. Asking for one of those commands
-here prints an explanation rather than an error.
+**Sealing is the one exception, and it is free.** `seal` writes an ASC MHL
+hash list and the convention alongside your media, touching none of it. A
+manifest is only worth what the far end can read for nothing, so the half
+that writes one cannot be the paid half.
+
+Conforming files to a convention, and undoing a conform run, are licensed
+separately as ShuttleCheck Pro. Asking for one of those commands here prints
+an explanation rather than an error.
 
 ## Licence
 
@@ -110,3 +115,7 @@ Free to install and use. Not open source: no right to redistribute or modify.
 See <https://mvrk.systems/shuttlecheck>.
 
 Made by [MVRK Systems](https://mvrk.systems).
+
+---
+
+ShuttleCheck™ and DailiesDrop™ are trademarks of MVRK Systems.

{shuttlecheck-0.2.1 → shuttlecheck-0.4.0}/README.md

@@ -1,4 +1,4 @@
-# ShuttleCheck — validator
+# ShuttleCheck, the validator
 
 Naming conformance for a folder tree: infer a spec from it, check it, fix it,
 undo the fix, and send the convention with the media. Installs as `shuttlecheck`;
@@ -16,7 +16,7 @@ talked into running on a live job, because running it cannot cost them anything.
 python -m pip install -e .
 ```
 
-`tzdata` is a real runtime dependency on Windows — the platform ships no system
+`tzdata` is a real runtime dependency on Windows, because the platform ships no system
 timezone database, so `zoneinfo` cannot resolve the agenda timezone without it.
 
 ## Use
@@ -109,7 +109,7 @@ Delivery rules, for contexts that declare a `deliverable:` profile:
 | `missing-sidecar` | error | Captions or checksum did not arrive with the file |
 | `no-video-stream`, `no-audio-stream`, `unreadable-media` | error | Not the kind of file it claims to be |
 | `color-*-mismatch` | error | Tagged with the wrong colour space |
-| `color-*-unknown` | warning | Not tagged at all — absence is not proof of wrongness |
+| `color-*-unknown` | warning | Not tagged at all. Absence is not proof of wrongness |
 | `incomplete-package` | error | A session or episode is short a deliverable |
 | `spec-unknown-deliverable` | error | A context points at a profile that is not defined |
 
@@ -120,7 +120,7 @@ Severities are overridable per rule in the spec's `rules:` block.
 `shuttlecheck ui` is a local web UI, not Electron and not Qt. The page ships
 inside the wheel and is served by the standard library's HTTP server, so the
 install stays `pip install shuttlecheck`, nothing is downloaded at runtime, and
-it works with no connection at all — which matters, because the machine this
+it works with no connection at all, which matters, because the machine this
 runs on is often in a truck. No web fonts either; the stylesheet falls back to
 whatever the OS has.
 
@@ -134,7 +134,7 @@ in the URL the browser is opened with, and never leaves the machine.
 
 **Applying a plan requires echoing back the move count.** The page states how
 many moves it believes it is approving. If the folder changed since the plan
-was drawn, the numbers disagree and nothing runs — a stale tab cannot apply a
+was drawn, the numbers disagree and nothing runs. A stale tab cannot apply a
 plan that no longer matches reality.
 
 ## How inference works
@@ -150,14 +150,14 @@ to try.
    has a different field count, anchor from the left and the right while the
    columns still look like fixed codes and treat the remainder as one variable
    field. Names structurally unrelated to the rest are set aside first, and
-   reported — they are usually the existing violations.
+   reported. They are usually the existing violations.
 3. **Profile** each column: constant, prefixed counter, enum, date, slug, or
    free text, each with a confidence and a plain-English reason.
 4. **Reconcile** value sets across groups, so a column that reads as the
    constant `HALLA` in one group and the enum `{HALLA, HALLB}` in another
    becomes one token rather than two.
-5. **Name** the fields from prefix semantics rather than exact widths — `D01`
-   and `DAY1` are both `{day}` — falling back to `{field3}` and flagging it.
+5. **Name** the fields from prefix semantics rather than exact widths, so `D01`
+   and `DAY1` are both `{day}`, falling back to `{field3}` and flagging it.
 6. **Self-validate**: run the validator over the same tree with the spec just
    inferred, and show the result. That is the thirty-second demonstration.
 
@@ -175,14 +175,14 @@ comments of the file it writes.
 It renames only what it can *derive*. For each non-conforming file:
 
 1. Parse the folder and the filename against the context's patterns.
-2. If both parse but disagree on a token, **skip** — there is no safe way to
+2. If both parse but disagree on a token, **skip**. There is no safe way to
    tell which one is the mistake, so it is a question for a human.
 3. If the name fails on a single field, recover that one field: from the folder
    path, by matching a known alias, by re-applying the token's own transforms
    (which fixes casing, spaces and punctuation), or from its declared source.
 4. If a context sets `schedule_check`, cross-check the schedule-bound tokens
    against the agenda and correct them. A name can parse perfectly and still be
-   wrong — `S001` recorded during `S005` is a valid shape carrying a false
+   wrong: `S001` recorded during `S005` is a valid shape carrying a false
    claim. An ambiguous clock window corrects nothing rather than guessing.
 5. If the correct name still cannot be derived, **skip and say why**. Inventing
    a session number is worse than leaving a bad filename.
@@ -194,7 +194,7 @@ Safety, none of it optional:
 | Dry run | The default. `--apply` is a separate, explicit act. |
 | Originals | `rename: never` contexts are never planned, moved, or renamed. |
 | Overwrite | Never. A destination that exists aborts the whole plan. |
-| Collisions | Two files resolving to one name abort everything — a half-renamed job is worse than an unrenamed one. |
+| Collisions | Two files resolving to one name abort everything. A half-renamed job is worse than an unrenamed one. |
 | Stale plans | Every source is re-checked for size and mtime before the first move. |
 | Case-only renames | Routed through a temporary name, as are swaps and cycles. |
 | Mid-run failure | Every completed move is rolled back, and the run is marked `rolled_back` in the journal. |
@@ -251,7 +251,7 @@ WHAT YOU ARE DELIVERING
     with      Subtitles ({stem}.srt)
 ```
 
-The pack is **derived**, never authored separately — a vendor cannot drift from
+The pack is **derived**, never authored separately, so a vendor cannot drift from
 a document they did not write. `vendors` is the other direction: point it at the
 incoming deliveries and it reports who is clear, who has errors, and who has
 sent nothing at all.
@@ -260,7 +260,7 @@ Two things worth knowing:
 
 **Out-of-scope contexts are kept as inert stubs, not deleted.** Contexts are
 first-match-wins, so removing an early one silently re-routes its files into a
-later catch-all — the ISO rushes would come back reported as malformed masters.
+later catch-all, and the ISO rushes would come back reported as malformed masters.
 The stubs preserve ordering and say plainly: not yours.
 
 **A vendor is never shown a rule they cannot act on.** Packages narrow to the
@@ -275,7 +275,7 @@ intended.
 
 Its second job matters more than undo. Every file carries an `original_path`,
 recorded the first time it is touched and never rewritten. When a spec is
-edited and the tree re-conformed, names are computed from that identity — never
+edited and the tree re-conformed, names are computed from that identity, never
 from the current name. Without it, tokens compound on every pass: the second
 run re-prefixes what the first already prefixed, and by the third edit the
 names are unrecoverable. That failure is silent and looks like it worked.
@@ -294,7 +294,7 @@ drive out of a Peli case. `seal` writes `_SPEC/` onto the drive itself:
 | `README.txt` | plain-language instructions for someone who has never heard of this tool |
 | `journal/` | what has been renamed, and by which spec revision |
 
-The receiving end runs `shuttlecheck verify .` — no spec to be told about, no
+The receiving end runs `shuttlecheck verify .` with no spec to be told about, no
 account, no connectivity. Sealing never touches the media; it only writes
 inside `_SPEC/`.
 
@@ -302,19 +302,19 @@ What `verify` reports:
 
 | | |
 |---|---|
-| `missing` | error — on the manifest, not on the drive; the copy is incomplete |
-| `size-mismatch` | error — damaged or replaced in transit |
-| `hash-mismatch` | error — same size, different contents (needs `--hash` at both ends) |
-| `added` | warning — on the drive but not the manifest |
-| `mtime-drift` | info — most copy tools do not preserve timestamps |
-| `clock-did-not-survive-copy` | warning — see below |
+| `missing` | error: on the manifest, not on the drive; the copy is incomplete |
+| `size-mismatch` | error: damaged or replaced in transit |
+| `hash-mismatch` | error: same size, different contents (needs `--hash` at both ends) |
+| `added` | warning: on the drive but not the manifest |
+| `mtime-drift` | info: most copy tools do not preserve timestamps |
+| `clock-did-not-survive-copy` | warning: see below |
 
 Two judgement calls worth knowing about.
 
 **Timestamp drift is not damage.** Most copy tools do not preserve mtime, so
 treating that as corruption would make every genuine transfer look broken.
 *But* if the spec joins the agenda on `file_mtime`, drift silently moves every
-recording to the wrong session and the naming findings become fiction — so that
+recording to the wrong session and the naming findings become fiction, so that
 specific combination is raised as a warning rather than left to be discovered.
 A spec using embedded timecode does not have the problem.
 
@@ -328,7 +328,7 @@ timestamps are all that can be checked, and the sidecar says so in writing.
 **It parses, it does not render.** The validator compiles each naming pattern
 into a regex whose groups are constrained by each token's own type, enum values,
 and transforms, then matches the existing name against it. That is why it needs
-no prompting, no schedule, and no media parser to do its core job — and why
+no prompting, no schedule, and no media parser to do its core job, and why
 `prompt`-sourced tokens validate fine.
 
 **Mismatches name the field.** On a failure it recompiles the pattern with each
@@ -363,7 +363,7 @@ shuttlecheck validate ./fixture --spec ./fixture/EXC26/_SPEC/spec.yaml
 ```
 
 `tests/make_infer_fixture.py` writes a tree using a convention the code has
-never seen — dashes instead of underscores, `DAY1` instead of `D01`, `SES001`
+never seen: dashes instead of underscores, `DAY1` instead of `D01`, `SES001`
 instead of `S001`, variable-length titles containing the separator, and
 camera-native ISO names. If inference recovers that, it is reading the tree
 rather than recognising something baked into the source:
@@ -379,7 +379,7 @@ errors in the files it learned from.
 
 Portability rules are unit-tested against the check functions rather than real
 files, because Windows cannot create a file named `NUL.mov`, `bad<name>.mov`, or
-`trailing..mov.` — which is the point of the check.
+`trailing..mov.`, which is the point of the check.
 
 ## Not built yet
 
@@ -388,5 +388,5 @@ files, because Windows cannot create a file named `NUL.mov`, `bad<name>.mov`, or
   creation time via `ffprobe` and degrades honestly without it.
 - Agenda formats other than CSV. `ics`, `sched`, `swapcard`, and `cvent` are in
   the schema and raise `ScheduleUnavailable` rather than failing the run.
-- The conformer, its journal, and revert. Deliberately absent — see the
+- The conformer, its journal, and revert. Deliberately absent: see the
   read-only boundary above.

{shuttlecheck-0.2.1 → shuttlecheck-0.4.0}/pyproject.toml

@@ -1,60 +1,74 @@
-[project]
-name = "shuttlecheck"
-version = "0.2.1"
-description = "Check media filenames, folder structure and deliverables against a written convention. Read-only."
-readme = { file = "PYPI.md", content-type = "text/markdown" }
-requires-python = ">=3.11"
-license = { text = "Proprietary — free to use, no redistribution" }
-authors = [{ name = "MVRK Systems", email = "hello@mvrk.systems" }]
-keywords = [
-    "broadcast", "post-production", "dailies", "media", "naming-convention",
-    "file-naming", "delivery", "conformance", "validation", "vfx", "video",
-]
-classifiers = [
-    "Development Status :: 4 - Beta",
-    "Environment :: Console",
-    "Environment :: Web Environment",
-    "Intended Audience :: End Users/Desktop",
-    "License :: Other/Proprietary License",
-    "Natural Language :: English",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Topic :: Multimedia :: Video",
-    "Topic :: System :: Archiving",
-    "Topic :: Utilities",
-]
-dependencies = [
-    "PyYAML>=6.0",
-    "jsonschema>=4.20",
-    # Windows ships no system tz database, so zoneinfo cannot resolve the
-    # agenda timezone without this. Required, not optional, on a target platform.
-    "tzdata>=2024.1; sys_platform == 'win32'",
-]
-
-[project.optional-dependencies]
-dev = ["pytest>=8.0"]
-
-[project.urls]
-Homepage = "https://mvrk.systems/shuttlecheck"
-Documentation = "https://mvrk.systems/shuttlecheck#checks"
-
-[project.scripts]
-shuttlecheck = "shuttlecheck.cli:main"
-
-[build-system]
-requires = ["setuptools>=68"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools]
-packages = ["shuttlecheck"]
-
-[tool.setuptools.package-data]
-# Neither schema is documentation. The validator refuses to run without the
-# spec schema, and the telemetry contract is checked against every batch before
-# it is sent, so a build that cannot read it sends nothing at all. Both travel
-# inside the wheel.
-shuttlecheck = ["schema.json", "telemetry-v1.schema.json", "ui_assets/*",
-                "ui_assets/fonts/*"]
+[project]
+name = "shuttlecheck"
+version = "0.4.0"
+description = "Check media filenames, folder structure and deliverables against a written convention. Read-only."
+readme = { file = "PYPI.md", content-type = "text/markdown" }
+requires-python = ">=3.11"
+license = { text = "Proprietary — free to use, no redistribution" }
+authors = [{ name = "MVRK Systems", email = "hello@mvrk.systems" }]
+keywords = [
+    "broadcast", "post-production", "dailies", "media", "naming-convention",
+    "file-naming", "delivery", "conformance", "validation", "vfx", "video",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Intended Audience :: End Users/Desktop",
+    "License :: Other/Proprietary License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Video",
+    "Topic :: System :: Archiving",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "PyYAML>=6.0",
+    "jsonschema>=4.20",
+    # xxh64 is the checksum the ASC MHL specification is usually written with
+    # and the one DailiesDrop records, and it is not in the standard library.
+    # A dependency in the read-only half looks like the wrong place for it
+    # until you notice that verifying a drive the appliance sealed is exactly
+    # what this half is for: without it, the common case degrades to "this
+    # installation cannot check those checksums".
+    "xxhash>=3.0",
+    # Windows ships no system tz database, so zoneinfo cannot resolve the
+    # agenda timezone without this. Required, not optional, on a target platform.
+    "tzdata>=2024.1; sys_platform == 'win32'",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0"]
+# The downloadable tool's own window, drawn by whatever webview the operating
+# system already has: WebView2 on Windows, WKWebView on macOS, WebKitGTK on
+# Linux. An extra rather than a dependency, because `pip install shuttlecheck`
+# is a library and a CLI and should not pull in a GUI stack, and because the
+# app falls back to a browser wherever this is missing. See
+# shuttlecheck/window.py.
+app = ["pywebview>=5.0"]
+
+[project.urls]
+Homepage = "https://mvrk.systems/shuttlecheck"
+Documentation = "https://mvrk.systems/shuttlecheck#checks"
+
+[project.scripts]
+shuttlecheck = "shuttlecheck.cli:main"
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["shuttlecheck"]
+
+[tool.setuptools.package-data]
+# Neither schema is documentation. The validator refuses to run without the
+# spec schema, and the telemetry contract is checked against every batch before
+# it is sent, so a build that cannot read it sends nothing at all. Both travel
+# inside the wheel.
+shuttlecheck = ["schema.json", "telemetry-v1.schema.json", "ui_assets/*",
+                "ui_assets/fonts/*"]

{shuttlecheck-0.2.1 → shuttlecheck-0.4.0}/shuttlecheck/__init__.py

@@ -1,18 +1,18 @@
-"""ShuttleCheck -- naming and delivery conformance.
+"""ShuttleCheck: naming and delivery conformance.
 
 Three entry points, in the order you would use them:
 
     infer_spec / walkthrough   read an existing tree and write the spec it follows
     Validator / validate       report what does not conform, in name and in
-                               substance -- codec, resolution, audio, packages
+                               substance: codec, resolution, audio, packages
     verify                     check a drive against the sidecar it arrived with
 
 **Nothing in this package modifies media.** That is the whole of it, and it is
 deliberate: a checker that cannot alter anything is a checker a stranger will
 run on a live job, because running it cannot cost them anything.
 
-The operations that write -- conforming, the journal, sealing a drive, vendor
-packs -- are licensed separately and ship as `shuttlecheck_pro`. When it is
+The operations that write (conforming, the journal, sealing a drive, vendor
+packs) are licensed separately and ship as `shuttlecheck_pro`. When it is
 installed, `extensions.load()` finds it and the CLI and app grow the extra
 commands; nothing here imports it, and nothing here requires it.
 """