resolvescript 0.1.2__tar.gz → 0.1.4a0__tar.gz

{resolvescript-0.1.2 → resolvescript-0.1.4a0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: resolvescript
-Version: 0.1.2
-Summary: CLI framework for building, coding, testing, packaging and installing DaVinci Resolve scripts.
+Version: 0.1.4a0
+Summary: CLI and library framework for building, coding, testing, packaging and installing DaVinci Resolve scripts.
 License: MIT
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
@@ -22,7 +22,18 @@ Requires-Dist: ruff>=0.1.0; extra == "dev"
 Dynamic: license-file
 
 # resolvescript
-
+<p align="center">
+  <strong>The only resolve scripting framework out there.</strong>
+  <br /><br />
+  <img src="https://img.shields.io/badge/python-%233670A0.svg?style=for-the-badge&amp;logo=python&amp;logoColor=ffdd54" alt="Python" />
+  <img src="https://img.shields.io/badge/davinci_resolve-%23233A51.svg?style=for-the-badge&amp;logo=davinciresolve&amp;logoColor=white" alt="DaVinci Resolve" />
+  <img src="https://img.shields.io/badge/pypi-%23ececec.svg?style=for-the-badge&amp;logo=pypi&amp;logoColor=1f73b7" alt="PyPI" />
+  <img src="https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&amp;logo=githubactions&amp;logoColor=white" alt="GitHub Actions" />
+</p>
+
+---
+
+## Overview
 Build, test, package and install [DaVinci Resolve](https://www.blackmagicdesign.com/products/davinciresolve) Python scripts and plugins: a small CLI with an npm-style workflow for the Resolve `Scripts/` tree.
 
 - `create` scaffolds a project with a `manifest.json` and smoke tests
@@ -33,6 +44,14 @@ Build, test, package and install [DaVinci Resolve](https://www.blackmagicdesign.
 
 Install with pip: `pip install resolvescript` (Python 3.12+).
 
+
+
+| Aspect          | Specification                     |
+| --------------- | --------------------------------- |
+| Current version | v0.1.4-alpha                      |
+| Resolve support | DaVinci Resolve Free & Studio 18+ |
+| License         | MIT                               |
+
 ## Quickstart
 
 ```console
@@ -133,6 +152,42 @@ Installs drop into each OS's Resolve Scripts root under the manifest `targets`.
 
 `resolvescript` ships a mock `DaVinciResolveScript` module with a faithful-enough Resolve color/editing/page object model for testing, plus `resolvescript test --api-coverage` to report which mock methods your tests actually exercise.
 
+## Library API
+
+`ResolveScript` is a first-class Python package — import it in any script:
+
+```python
+import ResolveScript as rs
+
+# scaffold a new project
+root, written = rs.scaffold_project("my_tool", destination=".")
+
+# static analysis
+issues = rs.analyze_project(root)
+
+# load & validate manifest
+manifest = rs.load_manifest(root / "manifest.json")
+rs.validate_manifest_or_throw(manifest)
+
+# consolidate to a single file
+cfg = rs.config_from_manifest(root, manifest)
+result = rs.consolidate(cfg)
+print(rs.summarize(result, cfg))
+
+# package a release artifact
+pkg = rs.package_project(root)
+print(pkg.archive)
+```
+
+Every name exported at the package root is also available from its owning submodule, e.g. `rs.consolidate` mirrors `ResolveScript.consolidate.consolidate`. The major subpackages are:
+
+- `ResolveScript.manifest` — model, loaders, validators
+- `ResolveScript.sandbox` — mock Resolve API, smoke runs, REPL
+- `ResolveScript.sources` — archive/GitHub/known-source helpers
+- `ResolveScript.install` — install, registry, target resolution
+
+Version: `rs.get_version()` returns the installed version string.
+
 ## Development
 
 ```console

{resolvescript-0.1.2 → resolvescript-0.1.4a0}/README.md

@@ -1,5 +1,16 @@
 # resolvescript
-
+<p align="center">
+  <strong>The only resolve scripting framework out there.</strong>
+  <br /><br />
+  <img src="https://img.shields.io/badge/python-%233670A0.svg?style=for-the-badge&amp;logo=python&amp;logoColor=ffdd54" alt="Python" />
+  <img src="https://img.shields.io/badge/davinci_resolve-%23233A51.svg?style=for-the-badge&amp;logo=davinciresolve&amp;logoColor=white" alt="DaVinci Resolve" />
+  <img src="https://img.shields.io/badge/pypi-%23ececec.svg?style=for-the-badge&amp;logo=pypi&amp;logoColor=1f73b7" alt="PyPI" />
+  <img src="https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&amp;logo=githubactions&amp;logoColor=white" alt="GitHub Actions" />
+</p>
+
+---
+
+## Overview
 Build, test, package and install [DaVinci Resolve](https://www.blackmagicdesign.com/products/davinciresolve) Python scripts and plugins: a small CLI with an npm-style workflow for the Resolve `Scripts/` tree.
 
 - `create` scaffolds a project with a `manifest.json` and smoke tests
@@ -10,6 +21,14 @@ Build, test, package and install [DaVinci Resolve](https://www.blackmagicdesign.
 
 Install with pip: `pip install resolvescript` (Python 3.12+).
 
+
+
+| Aspect          | Specification                     |
+| --------------- | --------------------------------- |
+| Current version | v0.1.4-alpha                      |
+| Resolve support | DaVinci Resolve Free & Studio 18+ |
+| License         | MIT                               |
+
 ## Quickstart
 
 ```console
@@ -110,6 +129,42 @@ Installs drop into each OS's Resolve Scripts root under the manifest `targets`.
 
 `resolvescript` ships a mock `DaVinciResolveScript` module with a faithful-enough Resolve color/editing/page object model for testing, plus `resolvescript test --api-coverage` to report which mock methods your tests actually exercise.
 
+## Library API
+
+`ResolveScript` is a first-class Python package — import it in any script:
+
+```python
+import ResolveScript as rs
+
+# scaffold a new project
+root, written = rs.scaffold_project("my_tool", destination=".")
+
+# static analysis
+issues = rs.analyze_project(root)
+
+# load & validate manifest
+manifest = rs.load_manifest(root / "manifest.json")
+rs.validate_manifest_or_throw(manifest)
+
+# consolidate to a single file
+cfg = rs.config_from_manifest(root, manifest)
+result = rs.consolidate(cfg)
+print(rs.summarize(result, cfg))
+
+# package a release artifact
+pkg = rs.package_project(root)
+print(pkg.archive)
+```
+
+Every name exported at the package root is also available from its owning submodule, e.g. `rs.consolidate` mirrors `ResolveScript.consolidate.consolidate`. The major subpackages are:
+
+- `ResolveScript.manifest` — model, loaders, validators
+- `ResolveScript.sandbox` — mock Resolve API, smoke runs, REPL
+- `ResolveScript.sources` — archive/GitHub/known-source helpers
+- `ResolveScript.install` — install, registry, target resolution
+
+Version: `rs.get_version()` returns the installed version string.
+
 ## Development
 
 ```console

{resolvescript-0.1.2 → resolvescript-0.1.4a0}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "resolvescript"
-version = "0.1.2"
-description = "CLI framework for building, coding, testing, packaging and installing DaVinci Resolve scripts."
+version = "0.1.4-alpha"
+description = "CLI and library framework for building, coding, testing, packaging and installing DaVinci Resolve scripts."
 readme = "README.md"
 requires-python = ">=3.9"
 license = {text = "MIT"}
@@ -29,20 +29,20 @@ dev = [
 ]
 
 [project.scripts]
-resolvescript = "resolve_script.cli:main"
+resolvescript = "ResolveScript.cli:main"
 
 [tool.setuptools.packages.find]
 where = ["src"]
-include = ["resolve_script*"]
+include = ["ResolveScript*"]
 
 [tool.setuptools.package-data]
-"resolve_script" = ["templates/**/*"]
+"ResolveScript" = ["templates/**/*"]
 
 [tool.ruff]
 line-length = 100
 target-version = "py39"
 extend-exclude = [
-    "src/resolve_script/templates",  # placeholders (@NAME@) are not valid Python
+    "src/ResolveScript/templates",  # placeholders (@NAME@) are not valid Python
 ]
 
 [tool.ruff.lint]

resolvescript-0.1.4a0/src/ResolveScript/__init__.py

@@ -0,0 +1,366 @@
+"""ResolveScript — script framework for DaVinci Resolve.
+
+ResolveScript is both a CLI and a normal Python package, so you can drive
+every feature directly from a script or an interactive session.
+
+Quick start — create and inspect a new script project::
+
+    import ResolveScript as rs
+
+    root, written = rs.scaffold_project(
+        "my-tool", destination=".", fmt="json", template="default"
+    )
+    print(root, written)
+
+    issues = rs.analyze_project(root)
+    for issue in issues:
+        print(issue)
+
+    cfg = rs.config_from_manifest(root / "resolve-script.manifest.json")
+    result = rs.consolidate(cfg)
+    print(result.target)      # single-file build
+    print(result.sources)     # files folded into the build
+
+Borrow a ``Source`` spec from a known GitHub project::
+
+    import ResolveScript as rs
+
+    print(rs.lookup("hello"))          # canonical source for a known name
+    values = rs.build_values("my-tool")  # template substition values
+
+Sit scripts in the Resolve environment::
+
+    from ResolveScript.sandbox import build_default_env, fake_resolve_module
+    from ResolveScript.install import install_project
+
+    env = build_default_env()
+    fake_resolve_module(env)           # injects a fake ``resolve`` module
+    install_project(env, run_smoke=True, root=".")
+
+Every public name is available both at the package root and from its owning
+module, e.g. ``ResolveScript.consolidate`` is also the top-level
+``consolidate`` function.
+
+Subpackages ship their own convenience imports:
+
+* ``ResolveScript.manifest``  — manifest model, loaders, validators
+* ``ResolveScript.sandbox``   — mock Resolve API, smoke runs, REPL
+* ``ResolveScript.sources``   — archive/git/known-source helpers
+* ``ResolveScript.install``   — install, registry and target resolution
+"""
+
+from __future__ import annotations
+
+from ._version import __version__, get_version
+
+# --- pipeline ----------------------------------------------------------
+from .analyze import KNOWN_ROOTS, Analysis, Issue, analyze_project, issues_to_json
+
+# --- config ------------------------------------------------------------
+from .config import (
+    allow_remote,
+    is_editable_install,
+    normalize_path,
+    plugins_dir,
+    python_spec,
+    scripts_root_override,
+    user_config_dir,
+)
+from .consolidate import (
+    BuildConfig,
+    ConsolidateError,
+    ConsolidateResult,
+    config_from_manifest,
+    consolidate,
+    summarize,
+)
+
+# --- fetch / CLI -------------------------------------------------------
+from .fetch import Fetched, FetchError, fetch, fetch_json, sha256_file
+
+# --- install -----------------------------------------------------------
+from .install import (
+    REGISTRY_REL,
+    SCHEMA_VERSION,
+    InstalledFile,
+    InstallError,
+    InstallOptions,
+    InstallResult,
+    RegistryError,
+    add_or_update_entry,
+    default_scripts_root,
+    discover_entrypoint,
+    get_extension,
+    install_package,
+    install_project,
+    read_registry,
+    registry_path,
+    remove_entry,
+    resolve_scripts_root,
+    select_files,
+    target_dir,
+    uninstall_package,
+    write_registry,
+)
+
+# --- manifest ----------------------------------------------------------
+from .manifest import (
+    TARGET_SUGGESTIONS,
+    Compat,
+    ConsolidateConfig,
+    InstallConfig,
+    Manifest,
+    ManifestError,
+    Release,
+    Target,
+    dumps,
+    is_valid_semver,
+    load_manifest,
+    loads,
+    manifest_from_dict,
+    validate_manifest,
+    validate_manifest_or_throw,
+    validate_target,
+)
+from .package import PackageError, PackageResult, package_project
+
+# --- spec / resolver ---------------------------------------------------
+from .resolver import (
+    Resolved,
+    ResolveError,
+    lockfile_satisfies,
+    resolve_spec,
+)
+
+# --- sandbox -----------------------------------------------------------
+from .sandbox import (
+    DEFAULT_PROJECT,
+    FUSION_SCRIPT_MODULE,
+    FakeClip,
+    FakeComp,
+    FakeFolder,
+    FakeFusion,
+    FakeKey,
+    FakeMediaPool,
+    FakeMediaPoolItem,
+    FakeProject,
+    FakeProjectManager,
+    FakeResolve,
+    FakeSpline,
+    FakeStroke,
+    FakeTimeline,
+    FakeTool,
+    SmokeCheck,
+    SmokeResult,
+    build_default_env,
+    default_namespace,
+    discover_exports,
+    fake_resolve_module,
+    install_fake_resolve,
+    load_built_module,
+    load_source_module,
+    purge_module,
+    run_smoke,
+    start_repl,
+)
+
+# --- scaffold ----------------------------------------------------------
+from .scaffold import (
+    DEFAULT_VERSION,
+    TEMPLATES_DIR,
+    ScaffoldError,
+    build_values,
+    normalize_name,
+    render,
+    scaffold_project,
+)
+from .semver import SemVerError, Version, matches, pick_best
+
+# --- sources -----------------------------------------------------------
+from .sources import (
+    ARCHIVE_SUFFIXES,
+    CONVENTIONS,
+    ArchiveError,
+    GitSourceError,
+    ReleaseError,
+    ReleaseSpec,
+    asset_download_url,
+    canonical_source,
+    codeload_url,
+    default_branch,
+    download_github,
+    is_archive_path,
+    known_names,
+    list_tags,
+    lookup,
+    make_archive,
+    resolve_tag,
+    search,
+    tags_have_version,
+    unpack_archive,
+)
+from .spec import Spec, SpecError, parse_specifier
+from .workspace import (
+    WORKSPACE_FILE,
+    WorkspaceError,
+    add_dependency,
+    has_workspace,
+    read_workspace,
+    remove_dependency,
+    save,
+    workspace_path,
+    write_workspace,
+)
+
+__all__ = [
+    # version
+    "__version__",
+    "get_version",
+    # manifest
+    "Compat",
+    "ConsolidateConfig",
+    "InstallConfig",
+    "Manifest",
+    "ManifestError",
+    "Release",
+    "TARGET_SUGGESTIONS",
+    "Target",
+    "dumps",
+    "is_valid_semver",
+    "load_manifest",
+    "loads",
+    "manifest_from_dict",
+    "validate_manifest",
+    "validate_manifest_or_throw",
+    "validate_target",
+    # sources
+    "ARCHIVE_SUFFIXES",
+    "CONVENTIONS",
+    "ArchiveError",
+    "GitSourceError",
+    "ReleaseError",
+    "ReleaseSpec",
+    "asset_download_url",
+    "canonical_source",
+    "codeload_url",
+    "default_branch",
+    "download_github",
+    "is_archive_path",
+    "known_names",
+    "list_tags",
+    "lookup",
+    "make_archive",
+    "resolve_tag",
+    "search",
+    "tags_have_version",
+    "unpack_archive",
+    # install
+    "REGISTRY_REL",
+    "SCHEMA_VERSION",
+    "InstallError",
+    "InstallOptions",
+    "InstallResult",
+    "InstalledFile",
+    "RegistryError",
+    "add_or_update_entry",
+    "default_scripts_root",
+    "discover_entrypoint",
+    "get_extension",
+    "install_package",
+    "install_project",
+    "read_registry",
+    "registry_path",
+    "remove_entry",
+    "resolve_scripts_root",
+    "select_files",
+    "target_dir",
+    "uninstall_package",
+    "write_registry",
+    # sandbox
+    "DEFAULT_PROJECT",
+    "FUSION_SCRIPT_MODULE",
+    "FakeClip",
+    "FakeComp",
+    "FakeFolder",
+    "FakeFusion",
+    "FakeKey",
+    "FakeMediaPool",
+    "FakeMediaPoolItem",
+    "FakeProject",
+    "FakeProjectManager",
+    "FakeResolve",
+    "FakeSpline",
+    "FakeStroke",
+    "FakeTimeline",
+    "FakeTool",
+    "SmokeCheck",
+    "SmokeResult",
+    "build_default_env",
+    "default_namespace",
+    "discover_exports",
+    "fake_resolve_module",
+    "install_fake_resolve",
+    "load_built_module",
+    "load_source_module",
+    "purge_module",
+    "run_smoke",
+    "start_repl",
+    # config
+    "allow_remote",
+    "is_editable_install",
+    "normalize_path",
+    "plugins_dir",
+    "python_spec",
+    "scripts_root_override",
+    "user_config_dir",
+    # spec / resolver
+    "ResolveError",
+    "Resolved",
+    "lockfile_satisfies",
+    "resolve_spec",
+    "SemVerError",
+    "Version",
+    "matches",
+    "pick_best",
+    "Spec",
+    "SpecError",
+    "parse_specifier",
+    "WORKSPACE_FILE",
+    "WorkspaceError",
+    "add_dependency",
+    "has_workspace",
+    "read_workspace",
+    "remove_dependency",
+    "save",
+    "workspace_path",
+    "write_workspace",
+    # pipeline
+    "KNOWN_ROOTS",
+    "Analysis",
+    "Issue",
+    "analyze_project",
+    "issues_to_json",
+    "BuildConfig",
+    "ConsolidateError",
+    "ConsolidateResult",
+    "config_from_manifest",
+    "consolidate",
+    "summarize",
+    "PackageError",
+    "PackageResult",
+    "package_project",
+    # scaffold
+    "DEFAULT_VERSION",
+    "TEMPLATES_DIR",
+    "ScaffoldError",
+    "build_values",
+    "normalize_name",
+    "render",
+    "scaffold_project",
+    # fetch
+    "Fetched",
+    "FetchError",
+    "fetch",
+    "fetch_json",
+    "sha256_file",
+]

resolvescript-0.1.4a0/src/ResolveScript/_version.py

@@ -0,0 +1,8 @@
+"""Package version metadata (imported by ``ResolveScript.__init__``)."""
+
+__version__ = "0.1.4-alpha"
+
+
+def get_version() -> str:
+    """Return the installed ``resolvescript`` version string."""
+    return __version__

{resolvescript-0.1.2/src/resolve_script → resolvescript-0.1.4a0/src/ResolveScript}/cli.py

@@ -429,6 +429,7 @@ def _cmd_manage_remove(args: argparse.Namespace) -> int:
     import shutil
 
     from .install.discovery import target_dir
+    from .install.installer import InstallError, validate_registry_name, validate_registry_relpath
     from .install.registry import get_extension, read_registry, remove_entry
 
     scripts_root = _resolve_scripts_root(args.scripts_root)
@@ -441,17 +442,27 @@ def _cmd_manage_remove(args: argparse.Namespace) -> int:
         )
         return 1
     as_directory = bool(entry.get("as_directory", True))
-    key = entry.get("id") or args.name
+    try:
+        key = validate_registry_name(entry.get("id") or args.name)
+        container_name = validate_registry_name(entry.get("name") or key)
+    except InstallError as exc:
+        print(f"resolvescript: manage remove: {exc}", file=sys.stderr)
+        return 1
     for target in entry.get("targets", []):
         base = target_dir(scripts_root, target)
         if as_directory:
-            container = base / (entry.get("name") or key)
+            container = base / container_name
             if container.is_dir():
                 shutil.rmtree(container)
                 print(f"removed {container}")
         else:
-            for rel in entry.get("files", []):
-                path = base / str(rel)
+            for raw_rel in entry.get("files", []):
+                try:
+                    rel = validate_registry_relpath(str(raw_rel))
+                except InstallError as exc:
+                    print(f"resolvescript: manage remove: {exc}", file=sys.stderr)
+                    return 1
+                path = base / rel
                 if path.is_file() or (path.is_symlink() and not path.exists()):
                     path.unlink()
                     print(f"removed {path}")
@@ -495,8 +506,8 @@ def _cmd_test(args: argparse.Namespace) -> int:
         env["RESOLVESCRIPT_BUILT_PATH"] = str(built_file)
         runner = (
             "import os, sys, pathlib\n"
-            "from resolve_script.sandbox.env import install_fake_resolve\n"
-            "from resolve_script.sandbox.loader import load_built_module\n"
+            "from ResolveScript.sandbox.env import install_fake_resolve\n"
+            "from ResolveScript.sandbox.loader import load_built_module\n"
             "install_fake_resolve()\n"
             "if os.environ.get('RESOLVESCRIPT_TARGET') == 'built':\n"
             "    name = os.environ['RESOLVESCRIPT_MODULE']\n"