shuttlecheck 0.4.3__tar.gz → 0.4.4__tar.gz

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shuttlecheck
-Version: 0.4.3
+Version: 0.4.4
 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

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shuttlecheck"
-version = "0.4.3"
+version = "0.4.4"
 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"

shuttlecheck-0.4.4/shuttlecheck/api_common.py

@@ -0,0 +1,58 @@
+"""What every set of app endpoints shares, kept apart from the route table.
+
+`ui` builds its route table when it is imported, and building it asks Pro for
+its routes, which imports `shuttlecheck_pro.web`. If `web` (or `seal_api`,
+which `web` imports) reached into `ui` for these, importing `web` first would
+start `ui`, `ui` would ask for `web`'s handlers, and `web` would not have
+defined them yet. So they live here, in a module that imports nothing of the
+app, and `ui` imports them back under the same names.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import yaml
+
+from .spec import Spec, SpecError, check_document
+
+
+class ApiError(Exception):
+    """A refusal the page is expected to render.
+
+    `detail` is merged into the JSON body beside the message. Most refusals
+    need nothing: the sentence is the whole answer. A few are a comparison --
+    this many now, that many when you looked, and a page that has to read
+    those numbers back out of an English sentence will get them wrong the first
+    time the sentence is reworded.
+    """
+
+    def __init__(self, message: str, status: int = 400, **detail):
+        super().__init__(message)
+        self.status = status
+        self.detail = detail
+
+
+def _spec_from_text(text: str, root: Path) -> Spec:
+    """Build a Spec anchored at <root>/_SPEC so relative sources still resolve."""
+    try:
+        doc = yaml.safe_load(text)
+    except yaml.YAMLError as exc:
+        raise ApiError(f"the spec is not valid YAML: {exc}")
+    try:
+        check_document(doc, "the spec in the editor")
+        return Spec(doc, root / "_SPEC" / "spec.yaml")
+    except SpecError as exc:
+        raise ApiError(str(exc))
+
+
+def _folder(payload: dict) -> Path:
+    raw = (payload.get("path") or "").strip().strip('"')
+    if not raw:
+        raise ApiError("no folder given")
+    path = Path(raw).expanduser()
+    if not path.exists():
+        raise ApiError(f"nothing at {path}")
+    if not path.is_dir():
+        raise ApiError(f"{path} is a file, not a folder")
+    return path.resolve()

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/shuttlecheck/extensions.py

@@ -1,9 +1,10 @@
 """Optional extensions.
 
-The open package is the read-only half: work out a convention, check a tree
-against it, check a drive that arrived. Everything that writes to media --
-conforming, the journal, sealing, vendor packs, ships separately and is
-licensed.
+The open package works out a convention, checks a tree against it, checks a
+drive that arrived, and seals a drive. The extension adds the operations that
+rename media (conforming, undoing a run, renaming by hand) plus vendor packs.
+A licence pays for the renaming and nothing else: sealing and vendor packs are
+free, by decision, since 0.4. See docs/COMMERCIAL.md.
 
 The base package must never require the extension, must never import it at
 module scope, and must behave as a complete tool without it. What it does do is
@@ -42,9 +43,10 @@ def require(what: str):
         raise ExtensionMissing(
             f"{what} is part of ShuttleCheck Pro, which is not installed on this "
             f"machine.\n"
-            f"The open package covers init, validate, verify and the app. "
-            f"everything that only reads.\n"
-            f"Conforming, sealing, the journal and vendor packs are licensed: "
+            f"The open package covers init, validate, verify, seal and the "
+            f"app.\n"
+            f"Conforming, undoing a run and vendor packs come with Pro; only "
+            f"conforming and undoing need a licence: "
             f"https://mvrk.systems/shuttlecheck")
     return module
 

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/shuttlecheck/seal_api.py

@@ -21,7 +21,9 @@ from shuttlecheck import jobs, mhl, provenance, store
 from shuttlecheck.sidecar import SIDECAR_DIR
 from shuttlecheck.spec import SpecError, find_convention, load_spec
 from shuttlecheck.validate import Validator
-from shuttlecheck.ui import ApiError, _folder, _spec_from_text
+# Not from shuttlecheck.ui: importing ui builds its route table, which
+# imports this module's handlers before they exist.
+from shuttlecheck.api_common import ApiError, _folder, _spec_from_text
 from shuttlecheck.seal import NOT_MEDIA, _existing_checksums, choose_algorithm
 from shuttlecheck.seal import seal as seal_drive
 

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/shuttlecheck/ui.py

@@ -45,6 +45,9 @@ from importlib import resources
 from pathlib import Path
 from urllib.parse import urlparse
 
+# Defined apart from this module so the handlers that live elsewhere can use
+# them without importing this one, whose import builds the route table.
+from .api_common import ApiError, _folder, _spec_from_text
 from . import (auth, endpoints, extensions, jobs, listener, receive, store,
                support, telemetry, today, updates, window)
 from .delivery import FFProbeProber
@@ -69,22 +72,6 @@ MIME = {".html": "text/html; charset=utf-8", ".css": "text/css; charset=utf-8",
 MAX_BODY = 8 * 1024 * 1024
 
 
-class ApiError(Exception):
-    """A refusal the page is expected to render.
-
-    `detail` is merged into the JSON body beside the message. Most refusals
-    need nothing: the sentence is the whole answer. A few are a comparison --
-    this many now, that many when you looked, and a page that has to read
-    those numbers back out of an English sentence will get them wrong the first
-    time the sentence is reworded.
-    """
-
-    def __init__(self, message: str, status: int = 400, **detail):
-        super().__init__(message)
-        self.status = status
-        self.detail = detail
-
-
 # --------------------------------------------------------------------------
 # Payload builders: one shape the page can rely on
 # --------------------------------------------------------------------------
@@ -120,19 +107,6 @@ def _inference(report) -> dict:
     }
 
 
-def _spec_from_text(text: str, root: Path) -> Spec:
-    """Build a Spec anchored at <root>/_SPEC so relative sources still resolve."""
-    try:
-        doc = yaml.safe_load(text)
-    except yaml.YAMLError as exc:
-        raise ApiError(f"the spec is not valid YAML: {exc}")
-    try:
-        check_document(doc, "the spec in the editor")
-        return Spec(doc, root / "_SPEC" / "spec.yaml")
-    except SpecError as exc:
-        raise ApiError(str(exc))
-
-
 # Places a person almost never means to point a tool at, and what to call
 # each one when asking. Read from the environment rather than hard-coded, so a
 # machine whose Windows lives on D: is covered and a test can point them
@@ -186,18 +160,6 @@ def sweeping(path: Path) -> str:
     return _sweeping_places().get(resolved, "")
 
 
-def _folder(payload: dict) -> Path:
-    raw = (payload.get("path") or "").strip().strip('"')
-    if not raw:
-        raise ApiError("no folder given")
-    path = Path(raw).expanduser()
-    if not path.exists():
-        raise ApiError(f"nothing at {path}")
-    if not path.is_dir():
-        raise ApiError(f"{path} is a file, not a folder")
-    return path.resolve()
-
-
 # --------------------------------------------------------------------------
 # API
 # --------------------------------------------------------------------------
@@ -2360,10 +2322,10 @@ def build_routes() -> dict:
         "/api/support/preview": api_support_preview,
         "/api/support/build": api_support_build,
     }
-    # Imported here rather than at module scope: seal_api reads ApiError and
-    # the folder helpers out of this module, so a top-level import would be a
-    # cycle. Sealing is free, so these sit in the table before Pro is asked
-    # for anything.
+    # Sealing is free, so these sit in the table before Pro is asked for
+    # anything. seal_api takes ApiError and the folder helpers from
+    # api_common, never from this module: this function runs while this
+    # module is still being imported.
     from .seal_api import api_seal, api_seal_preview
     routes["/api/seal/preview"] = api_seal_preview
     routes["/api/seal"] = api_seal

shuttlecheck-0.4.4/shuttlecheck/version.py

@@ -0,0 +1 @@
+__version__ = "0.4.4"

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/shuttlecheck.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shuttlecheck
-Version: 0.4.3
+Version: 0.4.4
 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

{shuttlecheck-0.4.3 → shuttlecheck-0.4.4}/shuttlecheck.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ shuttlecheck/__init__.py
 shuttlecheck/admission.py
 shuttlecheck/ale.py
 shuttlecheck/aliases.py
+shuttlecheck/api_common.py
 shuttlecheck/arrivals.py
 shuttlecheck/attribution.py
 shuttlecheck/auth.py

shuttlecheck-0.4.3/shuttlecheck/version.py

@@ -1 +0,0 @@
-__version__ = "0.4.3"