writing-scripts-and-cli-interfaces

What problem does it solve?

This guide helps developers structure and implement robust Python CLIs and scripts by enforcing typing, validation, and modular design across the CLI lifecycle.

Core Features & Use Cases

• Typed interfaces: enforce strict input/output models using Pydantic and validate_call for safe boundaries.
• Config-led workflows: TOML-based configuration with centralized settings to avoid config drift and improve maintainability.
• End-to-end CLI hygiene: JSON Schema generation, automatic documentation from docstrings, and lint/test integration to ensure quality.
• Use Case: Build a data-processing CLI that validates inputs, loads configuration, generates a JSON schema, and provides automated tests and help text.

Quick Start

Organize your CLI under src/your_cli and run uv run your_script.py to execute in an isolated environment.