schemify-cli 0.1.0__tar.gz → 0.2.0__tar.gz

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: schemify-cli
-Version: 0.1.0
+Version: 0.2.0
 Summary: Build JSON Schemas interactively, and fill JSON data from them, from the command line.
 Author: aaltatan
 Author-email: aaltatan <a.altatan@gmail.com>
@@ -27,7 +27,7 @@ schema updating as you type.
 ## Install
 
 ```bash
-uv tool install schemify
+uv tool install schemify-cli
 ```
 
 ## Usage
@@ -38,6 +38,19 @@ schemify fill person.schema.json -o person.json     # ask for one object matchin
 schemify list person.schema.json -f python          # ask for a list of them
 ```
 
+<!-- absolute URLs so the GIFs also show on PyPI -->
+`generate`: a `Person` with a `full_name` computed by joining `first` and `last`
+
+![schemify generate](https://raw.githubusercontent.com/aaltatan/schemify-cli/main/docs/demo/generate.gif)
+
+`fill`: one object, `full_name` is computed, not asked
+
+![schemify fill](https://raw.githubusercontent.com/aaltatan/schemify-cli/main/docs/demo/fill.gif)
+
+`list`: several objects, printed as Python
+
+![schemify list](https://raw.githubusercontent.com/aaltatan/schemify-cli/main/docs/demo/list.gif)
+
 | Command | Alias | Does |
 |---|---|---|
 | `generate` | `g` | Asks for the properties of an object and builds its JSON Schema (Draft 2020-12) |
@@ -79,7 +92,9 @@ Built-in computers:
 
 `schemify.cli.dependencies.schema` exposes typer-di dependencies that load a schema file and ask
 for its data: `FilledDataArgumentDI` and `FilledListArgumentDI` take the path as an argument,
-`FilledDataOptionDI` and `FilledListOptionDI` as `--js`.
+`FilledDataOptionDI` and `FilledListOptionDI` as `--js`. When the path is optional or comes from
+elsewhere, call `load_schema(path)` and `ask_or_abort(schema, ask_data)` directly: both report
+failures as typer errors.
 
 ## Development
 
@@ -89,5 +104,13 @@ uv run pytest
 uv run ruff check . && uv run mypy src
 ```
 
+The demo GIFs are recorded with [VHS](https://github.com/charmbracelet/vhs) (`scoop install vhs`
+or `brew install vhs`) and PowerShell (`pwsh`), from the repository root, `generate` first since
+the others use its schema:
+
+```bash
+vhs docs/demo/generate.tape && vhs docs/demo/fill.tape && vhs docs/demo/list.tape
+```
+
 After changing `generators.py`, `validators.py` or `computers.py`, run `pnpm sync && pnpm check`
-in [schemify-web](https://github.com/aaltatan/schemify-web) so it stays in step.
+in [the schemify editor](https://github.com/aaltatan/schemify) so it stays in step.

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/README.md

@@ -11,7 +11,7 @@ schema updating as you type.
 ## Install
 
 ```bash
-uv tool install schemify
+uv tool install schemify-cli
 ```
 
 ## Usage
@@ -22,6 +22,19 @@ schemify fill person.schema.json -o person.json     # ask for one object matchin
 schemify list person.schema.json -f python          # ask for a list of them
 ```
 
+<!-- absolute URLs so the GIFs also show on PyPI -->
+`generate`: a `Person` with a `full_name` computed by joining `first` and `last`
+
+![schemify generate](https://raw.githubusercontent.com/aaltatan/schemify-cli/main/docs/demo/generate.gif)
+
+`fill`: one object, `full_name` is computed, not asked
+
+![schemify fill](https://raw.githubusercontent.com/aaltatan/schemify-cli/main/docs/demo/fill.gif)
+
+`list`: several objects, printed as Python
+
+![schemify list](https://raw.githubusercontent.com/aaltatan/schemify-cli/main/docs/demo/list.gif)
+
 | Command | Alias | Does |
 |---|---|---|
 | `generate` | `g` | Asks for the properties of an object and builds its JSON Schema (Draft 2020-12) |
@@ -63,7 +76,9 @@ Built-in computers:
 
 `schemify.cli.dependencies.schema` exposes typer-di dependencies that load a schema file and ask
 for its data: `FilledDataArgumentDI` and `FilledListArgumentDI` take the path as an argument,
-`FilledDataOptionDI` and `FilledListOptionDI` as `--js`.
+`FilledDataOptionDI` and `FilledListOptionDI` as `--js`. When the path is optional or comes from
+elsewhere, call `load_schema(path)` and `ask_or_abort(schema, ask_data)` directly: both report
+failures as typer errors.
 
 ## Development
 
@@ -73,5 +88,13 @@ uv run pytest
 uv run ruff check . && uv run mypy src
 ```
 
+The demo GIFs are recorded with [VHS](https://github.com/charmbracelet/vhs) (`scoop install vhs`
+or `brew install vhs`) and PowerShell (`pwsh`), from the repository root, `generate` first since
+the others use its schema:
+
+```bash
+vhs docs/demo/generate.tape && vhs docs/demo/fill.tape && vhs docs/demo/list.tape
+```
+
 After changing `generators.py`, `validators.py` or `computers.py`, run `pnpm sync && pnpm check`
-in [schemify-web](https://github.com/aaltatan/schemify-web) so it stays in step.
+in [the schemify editor](https://github.com/aaltatan/schemify) so it stays in step.

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "schemify-cli"
-version = "0.1.0"
+version = "0.2.0"
 description = "Build JSON Schemas interactively, and fill JSON data from them, from the command line."
 readme = "README.md"
 requires-python = ">=3.12"

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/pyproject.toml.orig

@@ -1,43 +1,43 @@
-[project]
-name = "schemify-cli"
-version = "0.1.0"
-description = "Build JSON Schemas interactively, and fill JSON data from them, from the command line."
-readme = "README.md"
-authors = [
-    { name = "aaltatan", email = "a.altatan@gmail.com" }
-]
-requires-python = ">=3.12"
-dependencies = [
-    "jsonschema>=4.26.0",
-    "num2words>=0.5.14",
-    "questionary>=2.1.1",
-    "rich>=15.0.0",
-    "typer>=0.27.3",
-    "typer-di>=0.1.5",
-    "typer-swissknife>=0.1.1",
-]
-
-[project.scripts]
-schemify = "schemify.cli.main:main"
-
-[build-system]
-requires = ["uv_build>=0.13.5,<0.14.0"]
-build-backend = "uv_build"
-
-[dependency-groups]
-dev = [
-    "mypy>=2.4.1",
-    "pytest>=9.2.0",
-    "ruff>=0.17.3",
-    "types-jsonschema>=4.26.0.20261006",
-]
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-
-[[tool.mypy.overrides]]
-module = ["typer_swissknife", "num2words"]
-ignore_missing_imports = true
-
-[tool.uv.build-backend]
-module-name = "schemify"
+[project]
+name = "schemify-cli"
+version = "0.2.0"
+description = "Build JSON Schemas interactively, and fill JSON data from them, from the command line."
+readme = "README.md"
+authors = [
+    { name = "aaltatan", email = "a.altatan@gmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "jsonschema>=4.26.0",
+    "num2words>=0.5.14",
+    "questionary>=2.1.1",
+    "rich>=15.0.0",
+    "typer>=0.27.3",
+    "typer-di>=0.1.5",
+    "typer-swissknife>=0.1.1",
+]
+
+[project.scripts]
+schemify = "schemify.cli.main:main"
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=2.4.1",
+    "pytest>=9.2.0",
+    "ruff>=0.17.3",
+    "types-jsonschema>=4.26.0.20261006",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[[tool.mypy.overrides]]
+module = ["typer_swissknife", "num2words"]
+ignore_missing_imports = true
+
+[tool.uv.build-backend]
+module-name = "schemify"

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/src/schemify/__init__.py

@@ -4,15 +4,20 @@ from .computers import ComputeError, compute, computers
 from .fillers import InvalidDataError, ask_data, ask_list, fillers
 from .formatters import formatters
 from .generators import ask_schema, generators
+from .models import Schema
 from .registry import NotSupportedError
+from .validators import check_schema, check_value
 
 __all__ = [
     "ComputeError",
     "InvalidDataError",
     "NotSupportedError",
+    "Schema",
     "ask_data",
     "ask_list",
     "ask_schema",
+    "check_schema",
+    "check_value",
     "compute",
     "computers",
     "fillers",

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/src/schemify/cli/__init__.py

@@ -1 +1 @@
-"""The schemify command line interface."""
+"""The schemify command line interface."""

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/src/schemify/cli/dependencies/__init__.py

@@ -1,4 +1,4 @@
-"""Typer dependencies shared by the commands, injected with typer-di.
-
-They are importable by other typer-di apps, like templify.
-"""
+"""Typer dependencies shared by the commands, injected with typer-di.
+
+They are importable by other typer-di apps, like templify.
+"""

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/src/schemify/cli/dependencies/console.py

@@ -1,9 +1,9 @@
-"""The rich console used for command output."""
-
-from typing import Annotated
-
-from rich.console import Console
-from typer_di import Depends
-
-ConsoleDI = Annotated[Console, Depends(lambda: Console(color_system="truecolor"))]
-"""Injects a truecolor rich console."""
+"""The rich console used for command output."""
+
+from typing import Annotated
+
+from rich.console import Console
+from typer_di import Depends
+
+ConsoleDI = Annotated[Console, Depends(lambda: Console(color_system="truecolor"))]
+"""Injects a truecolor rich console."""

{schemify_cli-0.1.0 → schemify_cli-0.2.0}/src/schemify/cli/dependencies/schema.py

@@ -1,128 +1,145 @@
-"""The schema file, and the data the user fills from it, as an option or an argument.
-
-Other typer-di apps can reuse them, pick the version matching how the path is given:
-
-```python
-@app.command()
-def fill_template(data: FilledDataOptionDI) -> None: ...  # app --js person.json
-
-
-@app.command()
-def fill_template(data: FilledDataArgumentDI) -> None: ...  # app person.json
-
-
-@app.command()
-def fill_many(items: FilledListArgumentDI) -> None: ...  # app person.json, a list of people
-```
-"""
-
-import json
-from collections.abc import Callable
-from pathlib import Path
-from typing import Annotated, Any
-
-import typer
-from typer_di import Depends
-
-from schemify.fillers import InvalidDataError, ask_data, ask_list
-from schemify.models import Schema
-from schemify.registry import NotSupportedError
-from schemify.validators import check_schema
-
-_PATH_HELP = "Path to the JSON Schema file"
-
-# -----------------------
-# schema
-# -----------------------
-
-
-def _load_schema(path: Path) -> Schema:
-    try:
-        schema = json.loads(path.read_text(encoding="utf-8"))
-    except (json.JSONDecodeError, UnicodeDecodeError) as e:
-        msg = f"Could not read schema file '{path.name}': {e}"
-        raise typer.BadParameter(msg) from e
-
-    error = check_schema(schema)
-
-    if error is not None:
-        msg = f"Invalid schema file '{path.name}': {error}"
-        raise typer.BadParameter(msg)
-
-    return schema
-
-
-def _schema_from_option(
-    path: Annotated[
-        Path,
-        typer.Option(
-            "--js",
-            "--json-schema",
-            help=_PATH_HELP,
-            exists=True,
-            file_okay=True,
-            dir_okay=False,
-            resolve_path=True,
-        ),
-    ],
-) -> Schema:
-    return _load_schema(path)
-
-
-def _schema_from_argument(
-    path: Annotated[
-        Path,
-        typer.Argument(
-            help=_PATH_HELP,
-            exists=True,
-            file_okay=True,
-            dir_okay=False,
-            resolve_path=True,
-        ),
-    ],
-) -> Schema:
-    return _load_schema(path)
-
-
-# -----------------------
-# filled data
-# -----------------------
-
-
-def _filled_data(
-    read_schema: Callable[..., Schema], ask: Callable[[Schema], Any] = ask_data
-) -> Callable[..., Any]:
-    """Build a dependency asking (with `ask`) for data matching the schema `read_schema` injects."""
-
-    def fill(schema: Annotated[Schema, Depends(read_schema)]) -> Any:
-        try:
-            return ask(schema)
-        except (NotSupportedError, InvalidDataError) as e:
-            raise typer.BadParameter(str(e)) from e
-        except KeyboardInterrupt:
-            raise typer.Abort from None
-
-    return fill
-
-
-# -----------------------
-# DI
-# -----------------------
-
-SchemaOptionDI = Annotated[Schema, Depends(_schema_from_option)]
-"""Injects the valid JSON Schema read from the `--js` / `--json-schema` option."""
-
-SchemaArgumentDI = Annotated[Schema, Depends(_schema_from_argument)]
-"""Injects the valid JSON Schema read from the `PATH` argument."""
-
-FilledDataOptionDI = Annotated[Any, Depends(_filled_data(_schema_from_option))]
-"""Injects the data the user entered, matching the `--js` / `--json-schema` file."""
-
-FilledDataArgumentDI = Annotated[Any, Depends(_filled_data(_schema_from_argument))]
-"""Injects the data the user entered, matching the `PATH` argument file."""
-
-FilledListOptionDI = Annotated[list[Any], Depends(_filled_data(_schema_from_option, ask_list))]
-"""Injects the list of items the user entered, each matching the `--js` / `--json-schema` file."""
-
-FilledListArgumentDI = Annotated[list[Any], Depends(_filled_data(_schema_from_argument, ask_list))]
-"""Injects the list of items the user entered, each matching the `PATH` argument file."""
+"""The schema file, and the data the user fills from it, as an option or an argument.
+
+Other typer-di apps can reuse them, pick the version matching how the path is given:
+
+```python
+@app.command()
+def fill_template(data: FilledDataOptionDI) -> None: ...  # app --js person.json
+
+
+@app.command()
+def fill_template(data: FilledDataArgumentDI) -> None: ...  # app person.json
+
+
+@app.command()
+def fill_many(items: FilledListArgumentDI) -> None: ...  # app person.json, a list of people
+```
+"""
+
+import json
+from collections.abc import Callable
+from pathlib import Path
+from typing import Annotated, Any
+
+import typer
+from typer_di import Depends
+
+from schemify.fillers import InvalidDataError, ask_data, ask_list
+from schemify.models import Schema
+from schemify.registry import NotSupportedError
+from schemify.validators import check_schema
+
+_PATH_HELP = "Path to the JSON Schema file"
+
+# -----------------------
+# schema
+# -----------------------
+
+
+def load_schema(path: Path) -> Schema:
+    """Read a valid JSON Schema from `path`, a bad file is reported as a usage error.
+
+    Raises:
+        typer.BadParameter: The file is not JSON, or is not a valid JSON Schema.
+
+    """
+    try:
+        schema = json.loads(path.read_text(encoding="utf-8"))
+    except (json.JSONDecodeError, UnicodeDecodeError) as e:
+        msg = f"Could not read schema file '{path.name}': {e}"
+        raise typer.BadParameter(msg) from e
+
+    error = check_schema(schema)
+
+    if error is not None:
+        msg = f"Invalid schema file '{path.name}': {error}"
+        raise typer.BadParameter(msg)
+
+    return schema
+
+
+def _schema_from_option(
+    path: Annotated[
+        Path,
+        typer.Option(
+            "--js",
+            "--json-schema",
+            help=_PATH_HELP,
+            exists=True,
+            file_okay=True,
+            dir_okay=False,
+            resolve_path=True,
+        ),
+    ],
+) -> Schema:
+    return load_schema(path)
+
+
+def _schema_from_argument(
+    path: Annotated[
+        Path,
+        typer.Argument(
+            help=_PATH_HELP,
+            exists=True,
+            file_okay=True,
+            dir_okay=False,
+            resolve_path=True,
+        ),
+    ],
+) -> Schema:
+    return load_schema(path)
+
+
+# -----------------------
+# filled data
+# -----------------------
+
+
+def ask_or_abort[T](schema: Schema, ask: Callable[[Schema], T] = ask_data) -> T:
+    """Ask for data with `ask`, reporting failures the way a typer app expects.
+
+    Raises:
+        typer.BadParameter: The schema can not be filled, or the data does not match it.
+        typer.Abort: The user pressed Ctrl+C.
+
+    """
+    try:
+        return ask(schema)
+    except (NotSupportedError, InvalidDataError) as e:
+        raise typer.BadParameter(str(e)) from e
+    except KeyboardInterrupt:
+        raise typer.Abort from None
+
+
+def _filled_data(
+    read_schema: Callable[..., Schema], ask: Callable[[Schema], Any] = ask_data
+) -> Callable[..., Any]:
+    """Build a dependency asking (with `ask`) for data matching the schema `read_schema` injects."""
+
+    def fill(schema: Annotated[Schema, Depends(read_schema)]) -> Any:
+        return ask_or_abort(schema, ask)
+
+    return fill
+
+
+# -----------------------
+# DI
+# -----------------------
+
+SchemaOptionDI = Annotated[Schema, Depends(_schema_from_option)]
+"""Injects the valid JSON Schema read from the `--js` / `--json-schema` option."""
+
+SchemaArgumentDI = Annotated[Schema, Depends(_schema_from_argument)]
+"""Injects the valid JSON Schema read from the `PATH` argument."""
+
+FilledDataOptionDI = Annotated[Any, Depends(_filled_data(_schema_from_option))]
+"""Injects the data the user entered, matching the `--js` / `--json-schema` file."""
+
+FilledDataArgumentDI = Annotated[Any, Depends(_filled_data(_schema_from_argument))]
+"""Injects the data the user entered, matching the `PATH` argument file."""
+
+FilledListOptionDI = Annotated[list[Any], Depends(_filled_data(_schema_from_option, ask_list))]
+"""Injects the list of items the user entered, each matching the `--js` / `--json-schema` file."""
+
+FilledListArgumentDI = Annotated[list[Any], Depends(_filled_data(_schema_from_argument, ask_list))]
+"""Injects the list of items the user entered, each matching the `PATH` argument file."""