pydantic-wizard 0.1.0__tar.gz

pydantic_wizard-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gianluca Pagliara
+
+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.

pydantic_wizard-0.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: pydantic-wizard
+Version: 0.1.0
+Summary: Interactive wizard-style CLI for configuring Pydantic v2 models, with YAML serialization.
+Author-email: Gianluca Pagliara <pagliara.gianluca@gmail.com>
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Typing :: Typed
+Requires-Python: <3.14,>=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: typer>=0.15
+Requires-Dist: rich>=13.0
+Requires-Dist: questionary>=2.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Dynamic: license-file
+
+# pydantic-wizard
+
+Interactive wizard-style CLI for configuring [Pydantic v2](https://docs.pydantic.dev/) models, with YAML serialization.
+
+Point it at any `BaseModel` subclass and it will walk you through every field — with type-aware prompts, constraint validation, and nested model support — then save the result as a clean YAML file.
+
+## Features
+
+- **Zero boilerplate** — works with any Pydantic v2 `BaseModel`, no registration needed
+- **Type-aware prompts** — booleans get yes/no, enums get dropdowns, nested models recurse automatically
+- **Constraint enforcement** — respects `ge`, `le`, `gt`, `lt` and other Pydantic field validators
+- **15+ built-in type handlers** — scalars, `Decimal`, `Enum`, `Literal`, `datetime`, `Optional`, `list`, `set`, `dict`, `Union`, nested models
+- **YAML round-trip** — serialize with metadata, load back, edit, and re-save
+- **Interactive validation** — on error, re-prompts only the failing fields
+- **Extensible** — register custom `TypeHandler` implementations for domain-specific types
+- **Rich terminal output** — field panels, summary tables, and colored messages via [Rich](https://github.com/Textualize/rich)
+
+## Installation
+
+```bash
+pip install pydantic-wizard
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add pydantic-wizard
+```
+
+## Quick Start
+
+### Define a model
+
+```python
+# myapp/config.py
+from decimal import Decimal
+from pydantic import BaseModel, Field
+
+class DatabaseConfig(BaseModel):
+    host: str = Field(description="Database hostname")
+    port: int = Field(default=5432, ge=1, le=65535)
+    name: str = Field(description="Database name")
+    pool_size: int = Field(default=10, ge=1)
+    timeout: Decimal = Field(default=Decimal("30.0"), ge=0)
+    ssl_enabled: bool = Field(default=True)
+```
+
+### Run the wizard from the CLI
+
+```bash
+pydantic-wizard new myapp.config.DatabaseConfig -o db.yaml
+```
+
+The wizard will prompt you for each field with type-appropriate inputs, validate the result, and save to `db.yaml`.
+
+### Or use it programmatically
+
+```python
+from pydantic_wizard import prompt_model, serialize_to_yaml, validate_and_fix
+from myapp.config import DatabaseConfig
+from pathlib import Path
+
+# Interactive prompt for all fields
+data = prompt_model(DatabaseConfig)
+
+# Validate (re-prompts on errors)
+instance = validate_and_fix(DatabaseConfig, data)
+
+# Save to YAML
+serialize_to_yaml(data, DatabaseConfig, Path("db.yaml"), model_name="database")
+```
+
+## CLI Commands
+
+### `new` — Create a configuration
+
+```bash
+pydantic-wizard new <MODEL_FQN> [--output, -o PATH]
+```
+
+Walks through every field interactively, validates, and saves to YAML.
+
+### `edit` — Edit an existing configuration
+
+```bash
+pydantic-wizard edit <CONFIG_FILE> [--output, -o PATH]
+```
+
+Loads an existing YAML file and re-runs the wizard with current values as defaults.
+
+### `validate` — Validate a configuration
+
+```bash
+pydantic-wizard validate <CONFIG_FILE> [--model, -m FQN]
+```
+
+Validates a YAML file against its Pydantic model. The model class is resolved from YAML metadata or the `--model` flag.
+
+### `show-schema` — Show model schema
+
+```bash
+pydantic-wizard show-schema <MODEL_FQN>
+```
+
+Displays a formatted table of all fields, types, defaults, and descriptions.
+
+## Supported Types
+
+| Category | Types |
+|----------|-------|
+| **Scalars** | `str`, `int`, `float`, `bool`, `Decimal` |
+| **Enums & Literals** | `Enum` subclasses, `Literal["a", "b", "c"]` |
+| **Date & Time** | `datetime`, `time`, `timedelta` |
+| **Optional** | `T \| None`, `Optional[T]` |
+| **Collections** | `list[T]`, `set[T]`, `dict[K, V]` |
+| **Unions** | `A \| B \| C` (type selection prompt) |
+| **Nested Models** | Any `BaseModel` subclass (recursive prompting) |
+
+## Programmatic API
+
+### Introspection
+
+```python
+from pydantic_wizard import introspect_model, FieldSpec
+
+specs: list[FieldSpec] = introspect_model(DatabaseConfig)
+for spec in specs:
+    print(f"{spec.name}: {spec.inner_type}, required={spec.is_required}")
+```
+
+### Custom Type Handlers
+
+Register custom handlers for domain-specific types:
+
+```python
+from pydantic_wizard import TypeHandlerRegistry, prompt_model
+from pydantic_wizard.type_handlers import TypeHandler
+
+class MoneyHandler:
+    def can_handle(self, spec):
+        return spec.inner_type is Money
+
+    def prompt(self, spec, default=None):
+        raw = questionary.text(f"  {spec.name} (e.g. 100.00 USD):").ask()
+        return Money.parse(raw)
+
+    def serialize(self, value):
+        return str(value)
+
+    def deserialize(self, raw, spec):
+        return Money.parse(raw)
+
+# Use the custom registry
+registry = TypeHandlerRegistry()
+registry.register(MoneyHandler())  # inserted at front, takes priority
+data = prompt_model(MyConfig, registry=registry)
+```
+
+## YAML Output Format
+
+Generated YAML files include metadata for round-trip support:
+
+```yaml
+_metadata:
+  model_type: DatabaseConfig
+  configuration_class: myapp.config.DatabaseConfig
+  version: 0.1.0
+configuration:
+  host: localhost
+  port: 5432
+  name: mydb
+  pool_size: 10
+  timeout: "30.0"
+  ssl_enabled: true
+```
+
+- **Decimals** are serialized as quoted strings to preserve precision
+- **Enums** are serialized as their `.value`
+- **Sets** are serialized as sorted lists
+- **Datetimes** use ISO 8601 format
+
+## License
+
+MIT

pydantic_wizard-0.1.0/README.md

@@ -0,0 +1,184 @@
+# pydantic-wizard
+
+Interactive wizard-style CLI for configuring [Pydantic v2](https://docs.pydantic.dev/) models, with YAML serialization.
+
+Point it at any `BaseModel` subclass and it will walk you through every field — with type-aware prompts, constraint validation, and nested model support — then save the result as a clean YAML file.
+
+## Features
+
+- **Zero boilerplate** — works with any Pydantic v2 `BaseModel`, no registration needed
+- **Type-aware prompts** — booleans get yes/no, enums get dropdowns, nested models recurse automatically
+- **Constraint enforcement** — respects `ge`, `le`, `gt`, `lt` and other Pydantic field validators
+- **15+ built-in type handlers** — scalars, `Decimal`, `Enum`, `Literal`, `datetime`, `Optional`, `list`, `set`, `dict`, `Union`, nested models
+- **YAML round-trip** — serialize with metadata, load back, edit, and re-save
+- **Interactive validation** — on error, re-prompts only the failing fields
+- **Extensible** — register custom `TypeHandler` implementations for domain-specific types
+- **Rich terminal output** — field panels, summary tables, and colored messages via [Rich](https://github.com/Textualize/rich)
+
+## Installation
+
+```bash
+pip install pydantic-wizard
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add pydantic-wizard
+```
+
+## Quick Start
+
+### Define a model
+
+```python
+# myapp/config.py
+from decimal import Decimal
+from pydantic import BaseModel, Field
+
+class DatabaseConfig(BaseModel):
+    host: str = Field(description="Database hostname")
+    port: int = Field(default=5432, ge=1, le=65535)
+    name: str = Field(description="Database name")
+    pool_size: int = Field(default=10, ge=1)
+    timeout: Decimal = Field(default=Decimal("30.0"), ge=0)
+    ssl_enabled: bool = Field(default=True)
+```
+
+### Run the wizard from the CLI
+
+```bash
+pydantic-wizard new myapp.config.DatabaseConfig -o db.yaml
+```
+
+The wizard will prompt you for each field with type-appropriate inputs, validate the result, and save to `db.yaml`.
+
+### Or use it programmatically
+
+```python
+from pydantic_wizard import prompt_model, serialize_to_yaml, validate_and_fix
+from myapp.config import DatabaseConfig
+from pathlib import Path
+
+# Interactive prompt for all fields
+data = prompt_model(DatabaseConfig)
+
+# Validate (re-prompts on errors)
+instance = validate_and_fix(DatabaseConfig, data)
+
+# Save to YAML
+serialize_to_yaml(data, DatabaseConfig, Path("db.yaml"), model_name="database")
+```
+
+## CLI Commands
+
+### `new` — Create a configuration
+
+```bash
+pydantic-wizard new <MODEL_FQN> [--output, -o PATH]
+```
+
+Walks through every field interactively, validates, and saves to YAML.
+
+### `edit` — Edit an existing configuration
+
+```bash
+pydantic-wizard edit <CONFIG_FILE> [--output, -o PATH]
+```
+
+Loads an existing YAML file and re-runs the wizard with current values as defaults.
+
+### `validate` — Validate a configuration
+
+```bash
+pydantic-wizard validate <CONFIG_FILE> [--model, -m FQN]
+```
+
+Validates a YAML file against its Pydantic model. The model class is resolved from YAML metadata or the `--model` flag.
+
+### `show-schema` — Show model schema
+
+```bash
+pydantic-wizard show-schema <MODEL_FQN>
+```
+
+Displays a formatted table of all fields, types, defaults, and descriptions.
+
+## Supported Types
+
+| Category | Types |
+|----------|-------|
+| **Scalars** | `str`, `int`, `float`, `bool`, `Decimal` |
+| **Enums & Literals** | `Enum` subclasses, `Literal["a", "b", "c"]` |
+| **Date & Time** | `datetime`, `time`, `timedelta` |
+| **Optional** | `T \| None`, `Optional[T]` |
+| **Collections** | `list[T]`, `set[T]`, `dict[K, V]` |
+| **Unions** | `A \| B \| C` (type selection prompt) |
+| **Nested Models** | Any `BaseModel` subclass (recursive prompting) |
+
+## Programmatic API
+
+### Introspection
+
+```python
+from pydantic_wizard import introspect_model, FieldSpec
+
+specs: list[FieldSpec] = introspect_model(DatabaseConfig)
+for spec in specs:
+    print(f"{spec.name}: {spec.inner_type}, required={spec.is_required}")
+```
+
+### Custom Type Handlers
+
+Register custom handlers for domain-specific types:
+
+```python
+from pydantic_wizard import TypeHandlerRegistry, prompt_model
+from pydantic_wizard.type_handlers import TypeHandler
+
+class MoneyHandler:
+    def can_handle(self, spec):
+        return spec.inner_type is Money
+
+    def prompt(self, spec, default=None):
+        raw = questionary.text(f"  {spec.name} (e.g. 100.00 USD):").ask()
+        return Money.parse(raw)
+
+    def serialize(self, value):
+        return str(value)
+
+    def deserialize(self, raw, spec):
+        return Money.parse(raw)
+
+# Use the custom registry
+registry = TypeHandlerRegistry()
+registry.register(MoneyHandler())  # inserted at front, takes priority
+data = prompt_model(MyConfig, registry=registry)
+```
+
+## YAML Output Format
+
+Generated YAML files include metadata for round-trip support:
+
+```yaml
+_metadata:
+  model_type: DatabaseConfig
+  configuration_class: myapp.config.DatabaseConfig
+  version: 0.1.0
+configuration:
+  host: localhost
+  port: 5432
+  name: mydb
+  pool_size: 10
+  timeout: "30.0"
+  ssl_enabled: true
+```
+
+- **Decimals** are serialized as quoted strings to preserve precision
+- **Enums** are serialized as their `.value`
+- **Sets** are serialized as sorted lists
+- **Datetimes** use ISO 8601 format
+
+## License
+
+MIT

pydantic_wizard-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pydantic-wizard"
+version = "0.1.0"
+description = "Interactive wizard-style CLI for configuring Pydantic v2 models, with YAML serialization."
+readme = "README.md"
+authors = [{ name = "Gianluca Pagliara", email = "pagliara.gianluca@gmail.com" }]
+requires-python = ">=3.13,<3.14"
+classifiers = [
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Typing :: Typed",
+]
+dependencies = [
+  "pydantic>=2.0",
+  "typer>=0.15",
+  "rich>=13.0",
+  "questionary>=2.0",
+  "PyYAML>=6.0",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest",
+  "ruff",
+  "mypy",
+  "types-PyYAML",
+]
+
+[project.scripts]
+pydantic-wizard = "pydantic_wizard.app:app"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["pydantic_wizard*"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py313"
+
+[tool.ruff.lint]
+select = [
+  "E",
+  "W",
+  "F",
+  "I",
+  "C",
+  "B",
+  "UP",
+]
+ignore = [
+  "C901",
+  "E203",
+  "E501",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.mypy]
+python_version = "3.13"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+strict = true
+ignore_missing_imports = true
+disable_error_code = ["misc"]
+exclude = ["tests/.*"]
+namespace_packages = true
+explicit_package_bases = true
+mypy_path = ["src"]

pydantic_wizard-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pydantic_wizard-0.1.0/src/pydantic_wizard/__init__.py

@@ -0,0 +1,45 @@
+"""pydantic-wizard: Interactive wizard-style CLI for configuring Pydantic v2 models."""
+
+from pydantic_wizard.display import (
+    display_model_list,
+    display_schema,
+    display_summary_table,
+    display_validation_errors,
+)
+from pydantic_wizard.introspection import (
+    FieldSpec,
+    get_type_display_name,
+    introspect_model,
+)
+from pydantic_wizard.prompts import prompt_model
+from pydantic_wizard.serialization import (
+    load_from_yaml,
+    resolve_config_class,
+    serialize_to_yaml,
+)
+from pydantic_wizard.type_handlers import TypeHandler, TypeHandlerRegistry
+from pydantic_wizard.validation import validate_and_fix, validate_config
+
+__all__ = [
+    # Introspection
+    "FieldSpec",
+    "introspect_model",
+    "get_type_display_name",
+    # Prompting
+    "prompt_model",
+    # Serialization
+    "serialize_to_yaml",
+    "load_from_yaml",
+    "resolve_config_class",
+    # Validation
+    "validate_config",
+    "validate_and_fix",
+    # Type handlers
+    "TypeHandler",
+    "TypeHandlerRegistry",
+    # Display
+    "display_model_list",
+    "display_schema",
+    "display_summary_table",
+    "display_validation_errors",
+]