cli-wizard 2.0.0__tar.gz → 3.0.0__tar.gz

{cli_wizard-2.0.0/src/cli_wizard.egg-info → cli_wizard-3.0.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: cli-wizard
-Version: 2.0.0
+Version: 3.0.0
 Summary: Generate modern CLIs from OpenAPI specifications
 Author-email: Giacomo Marciani <giacomo.marciani@gmail.com>
 License: MIT
-Project-URL: Homepage, https://github.com/gmarciani/cli-wizard
+Project-URL: Homepage, https://gmarciani.github.io/cli-wizard/
 Project-URL: Repository, https://github.com/gmarciani/cli-wizard
 Project-URL: Issues, https://github.com/gmarciani/cli-wizard/issues
 Classifier: Development Status :: 5 - Production/Stable
@@ -17,30 +17,12 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click~=8.3.1
-Requires-Dist: Jinja2~=3.1.6
-Requires-Dist: pydantic~=2.12.5
-Requires-Dist: PyYAML~=6.0.3
-Requires-Dist: requests~=2.32.5
-Provides-Extra: dev
-Requires-Dist: autoflake~=2.3; extra == "dev"
-Requires-Dist: black~=26.1; extra == "dev"
-Requires-Dist: build~=1.4; extra == "dev"
-Requires-Dist: flake8~=7.3; extra == "dev"
-Requires-Dist: mypy~=1.19; extra == "dev"
-Requires-Dist: pre-commit~=4.5; extra == "dev"
-Requires-Dist: pytest~=9.0; extra == "dev"
-Requires-Dist: pytest-cov~=7.0; extra == "dev"
-Requires-Dist: tox~=4.34; extra == "dev"
-Requires-Dist: twine~=6.2; extra == "dev"
-Requires-Dist: types-PyYAML~=6.0; extra == "dev"
-Requires-Dist: types-requests~=2.32; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: sphinx~=9.1; extra == "docs"
-Requires-Dist: sphinx-click~=6.2; extra == "docs"
-Requires-Dist: sphinx-rtd-theme~=3.1; extra == "docs"
-Requires-Dist: sphinx-new-tab-link~=0.8; extra == "docs"
-Requires-Dist: autodoc_pydantic~=2.2; extra == "docs"
+Requires-Dist: click~=8.4
+Requires-Dist: Jinja2~=3.1
+Requires-Dist: pydantic~=2.13
+Requires-Dist: PyYAML~=6.0
+Requires-Dist: requests~=2.34
+Requires-Dist: ruff~=0.16.2
 Dynamic: license-file
 
 # CLI WIZARD
@@ -49,12 +31,12 @@ Dynamic: license-file
 <img src="https://raw.githubusercontent.com/gmarciani/cli-wizard/main/resources/brand/banner.png" alt="cli-wizard-banner" width="500">
 
 [![PyPI version](https://img.shields.io/pypi/v/cli-wizard.svg)](https://pypi.org/project/cli-wizard)
-[![Python versions](https://img.shields.io/pypi/pyversions/cli-wizard.svg)](https://pypi.org/project/cli-wizard)
+[![Python versions](https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue.svg)](https://pypi.org/project/cli-wizard)
 [![License](https://img.shields.io/github/license/gmarciani/cli-wizard.svg)](https://github.com/gmarciani/cli-wizard/blob/main/LICENSE)
 [![Build status](https://img.shields.io/github/actions/workflow/status/gmarciani/cli-wizard/test.yaml?branch=main)](https://github.com/gmarciani/cli-wizard/actions)
 [![Tests](https://img.shields.io/github/actions/workflow/status/gmarciani/cli-wizard/test.yaml?branch=main&label=tests)](https://github.com/gmarciani/cli-wizard/actions)
 [![Coverage](https://img.shields.io/codecov/c/github/gmarciani/cli-wizard)](https://codecov.io/gh/gmarciani/cli-wizard)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-261230.svg)](https://github.com/astral-sh/ruff)
 [![Downloads](https://img.shields.io/pypi/dm/cli-wizard.svg)](https://pypi.org/project/cli-wizard)
 
 </div>
@@ -78,7 +60,7 @@ Generate modern CLIs from OpenAPI specifications.
 - Automatic command grouping based on OpenAPI tags
 - Automatic help generation for all commands
 - Clean, colored terminal output
-- `--debug` flag for verbose logging
+- `--debug` flag for verbose logging, with credentials redacted from the output
 - Built-in API client with configurable base URL and timeout
 - SSL/TLS support with custom CA certificate bundles
 - `--ca-file` option to specify custom CA certificates at runtime
@@ -94,7 +76,13 @@ Generate modern CLIs from OpenAPI specifications.
 
 ### Developer Experience
 - Generated projects are pip-installable out of the box
-- Auto-generated `pyproject.toml`, `README.md`, and `VERSION`
+- Auto-generated `pyproject.toml` and `VERSION`
+- Auto-generated `README.md` with commands and configuration reference
+- Auto-generated `DEVELOPMENT.md`, `CHANGELOG.md` and `LICENSE`
+- Test suite for the generated CLI, ready to run
+- `tox.ini` with test, lint, type, format and coverage environments, plus a `Makefile` wrapping them
+- Pre-commit configuration running ruff and mypy
+- Optional GitHub setup (`IncludeGithubWorkflows`): test, release, docs, PR validation, CodeQL, changelog and labeler workflows, plus Dependabot, issue and PR templates, and `CODEOWNERS`
 - Resources (CA certs, splash files) bundled in the package
 - Profile management for storing credentials and settings
 
@@ -127,51 +115,74 @@ paths:
           description: OK
 ```
 
-### Step 2: Create a Configuration File
+### Step 2: Generate the CLI
 
-Create a `cli-wizard.yaml` file with your CLI settings. At minimum, you need `PackageName` and `DefaultBaseUrl`:
+Run the `generate` command, passing the OpenAPI spec and a project name:
+
+```shell
+cli-wizard generate --api openapi.yaml --project-name "My CLI"
+```
+
+This creates a complete Python CLI project in the `my-cli` directory: the
+command name derives from the project name, and every other setting takes its
+default. Pass `--output` to write it elsewhere.
+
+### Step 3: Install the Generated CLI
+
+Navigate to the generated project and install it:
+
+```shell
+pip install -e my-cli
+```
+
+### Step 4: Use Your CLI
+
+Your CLI is now ready to use:
+
+```shell
+my-cli --help
+my-cli users list-users
+```
+
+### Step 5: Customize with a Configuration File
+
+To go beyond the defaults, create a `cli-wizard.yaml` file with the settings you
+want to change. Every parameter is optional:
 
 ```yaml
-# Required parameters
-PackageName: "my-cli"
+ProjectName: "My CLI"
 DefaultBaseUrl: "https://api.example.com"
 
-# Optional: customize the splash screen
+# Customize the splash screen
 SplashFile: "splash.txt"
 SplashColor: "#00FFFF"
 
-# Optional: filter which tags to include
+# Filter which tags to include
 IncludeTags:
   - Users
   - Products
 ```
 
-### Step 3: Generate the CLI
-
-Run the `generate` command:
+Then generate from it. The project lands in the current directory, in a
+directory named after `CommandName`:
 
 ```shell
-cli-wizard generate --openapi openapi.yaml --config cli-wizard.yaml --output my-cli
+cli-wizard generate --configuration cli-wizard.yaml --api openapi.yaml
 ```
 
-This creates a complete Python CLI project in the `my-cli` directory.
+### Starting Without a Specification
 
-### Step 4: Install the Generated CLI
-
-Navigate to the generated project and install it:
+To start from scratch instead, run `bootstrap`. It prompts for the main
+settings, writes a commented `cli-wizard.yaml`, and generates a basic CLI from
+it, without API commands. The CLI lands in the current directory, in a
+directory named after `CommandName`; pass `--output` to write it elsewhere:
 
 ```shell
-pip install -e my-cli
+cli-wizard bootstrap --configuration cli-wizard.yaml
 ```
 
-### Step 5: Use Your CLI
-
-Your CLI is now ready to use:
-
-```shell
-my-cli --help
-my-cli users list-users
-```
+Then edit the configuration, point `Api` at your specification, and rebuild
+with `cli-wizard generate --configuration cli-wizard.yaml`.
 
 ## Configuration
 
@@ -182,17 +193,34 @@ See the [examples](examples/) directory for complete configuration examples.
 
 ### cli-wizard generate
 
-Generate a CLI from an OpenAPI specification and configuration file.
+Generate a CLI from an OpenAPI specification, with an optional configuration file.
 
 ```shell
 cli-wizard generate [OPTIONS]
 ```
 
 Options:
-- `--openapi, -o` - Path to OpenAPI spec file (default: `openapi.yaml`)
-- `--config, -c` - Path to config YAML file (default: `cli-wizard.yaml`)
-- `--output, -d` - Output directory for generated CLI (default: `cli`)
-- `--working-dir, -w` - Working directory for resolving relative paths
+- `--api, -a` - Path to the OpenAPI spec file, YAML or JSON. Without it and without `Api` in the configuration, the CLI is generated without API commands
+- `--configuration, -c` - Path to the `cli-wizard.yaml` configuration file. Without it, every parameter takes its default
+- `--project-name, -p` - Human-readable project name; the generated command name derives from it, unless the configuration sets it
+- `--output, -o` - Output directory (default: a directory named after `CommandName` in the current directory)
+- `--force, -f` - Skip the confirmation prompt when the output directory is not empty
+
+### cli-wizard bootstrap
+
+Bootstrap a new CLI project interactively, without an OpenAPI specification.
+It does two things: it writes a configuration file to evolve the project from,
+then generates a basic CLI from that file, without API commands, in the output
+directory.
+
+```shell
+cli-wizard bootstrap [OPTIONS]
+```
+
+Options:
+- `--configuration, -c` - Path for the `cli-wizard.yaml` configuration file (default: `./cli-wizard.yaml`). An existing file is overwritten, after confirmation, without keeping any of its values
+- `--output, -o` - Output directory of the basic CLI (default: a directory named after `CommandName` in the current directory)
+- `--force, -f` - Skip the confirmation prompts to overwrite an existing configuration file or to write into a non-empty directory
 
 ## Issues
 

cli_wizard-3.0.0/README.md

@@ -0,0 +1,204 @@
+# CLI WIZARD
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/gmarciani/cli-wizard/main/resources/brand/banner.png" alt="cli-wizard-banner" width="500">
+
+[![PyPI version](https://img.shields.io/pypi/v/cli-wizard.svg)](https://pypi.org/project/cli-wizard)
+[![Python versions](https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue.svg)](https://pypi.org/project/cli-wizard)
+[![License](https://img.shields.io/github/license/gmarciani/cli-wizard.svg)](https://github.com/gmarciani/cli-wizard/blob/main/LICENSE)
+[![Build status](https://img.shields.io/github/actions/workflow/status/gmarciani/cli-wizard/test.yaml?branch=main)](https://github.com/gmarciani/cli-wizard/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/gmarciani/cli-wizard/test.yaml?branch=main&label=tests)](https://github.com/gmarciani/cli-wizard/actions)
+[![Coverage](https://img.shields.io/codecov/c/github/gmarciani/cli-wizard)](https://codecov.io/gh/gmarciani/cli-wizard)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-261230.svg)](https://github.com/astral-sh/ruff)
+[![Downloads](https://img.shields.io/pypi/dm/cli-wizard.svg)](https://pypi.org/project/cli-wizard)
+
+</div>
+
+Generate modern CLIs from OpenAPI specifications.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Commands](#commands)
+- [Issues](#issues)
+- [License](#license)
+
+## Features
+
+### Code Generation
+- Generate complete Python CLI projects from OpenAPI v3 specifications
+- Automatic command grouping based on OpenAPI tags
+- Automatic help generation for all commands
+- Clean, colored terminal output
+- `--debug` flag for verbose logging, with credentials redacted from the output
+- Built-in API client with configurable base URL and timeout
+- SSL/TLS support with custom CA certificate bundles
+- `--ca-file` option to specify custom CA certificates at runtime
+- `--no-verify-ssl` flag to disable certificate verification
+
+### Customization
+- YAML-based configuration for full customization
+- Configurable output directory and package name
+- Tag inclusion/exclusion filters
+- Custom command naming via `TagMapping` and `CommandMapping`
+- Customizable splash screen with color support
+- Configurable logging with colors, file output, and rotation
+
+### Developer Experience
+- Generated projects are pip-installable out of the box
+- Auto-generated `pyproject.toml` and `VERSION`
+- Auto-generated `README.md` with commands and configuration reference
+- Auto-generated `DEVELOPMENT.md`, `CHANGELOG.md` and `LICENSE`
+- Test suite for the generated CLI, ready to run
+- `tox.ini` with test, lint, type, format and coverage environments, plus a `Makefile` wrapping them
+- Pre-commit configuration running ruff and mypy
+- Optional GitHub setup (`IncludeGithubWorkflows`): test, release, docs, PR validation, CodeQL, changelog and labeler workflows, plus Dependabot, issue and PR templates, and `CODEOWNERS`
+- Resources (CA certs, splash files) bundled in the package
+- Profile management for storing credentials and settings
+
+## Installation
+
+```shell
+pip install cli-wizard
+```
+
+## Usage
+
+### Step 1: Prepare Your OpenAPI Specification
+
+Ensure you have an OpenAPI v3 specification file (JSON or YAML format). For example, `openapi.yaml`:
+
+```yaml
+openapi: 3.0.0
+info:
+  title: My API
+  version: 1.0.0
+paths:
+  /users:
+    get:
+      operationId: listUsers
+      summary: List all users
+      tags:
+        - Users
+      responses:
+        '200':
+          description: OK
+```
+
+### Step 2: Generate the CLI
+
+Run the `generate` command, passing the OpenAPI spec and a project name:
+
+```shell
+cli-wizard generate --api openapi.yaml --project-name "My CLI"
+```
+
+This creates a complete Python CLI project in the `my-cli` directory: the
+command name derives from the project name, and every other setting takes its
+default. Pass `--output` to write it elsewhere.
+
+### Step 3: Install the Generated CLI
+
+Navigate to the generated project and install it:
+
+```shell
+pip install -e my-cli
+```
+
+### Step 4: Use Your CLI
+
+Your CLI is now ready to use:
+
+```shell
+my-cli --help
+my-cli users list-users
+```
+
+### Step 5: Customize with a Configuration File
+
+To go beyond the defaults, create a `cli-wizard.yaml` file with the settings you
+want to change. Every parameter is optional:
+
+```yaml
+ProjectName: "My CLI"
+DefaultBaseUrl: "https://api.example.com"
+
+# Customize the splash screen
+SplashFile: "splash.txt"
+SplashColor: "#00FFFF"
+
+# Filter which tags to include
+IncludeTags:
+  - Users
+  - Products
+```
+
+Then generate from it. The project lands in the current directory, in a
+directory named after `CommandName`:
+
+```shell
+cli-wizard generate --configuration cli-wizard.yaml --api openapi.yaml
+```
+
+### Starting Without a Specification
+
+To start from scratch instead, run `bootstrap`. It prompts for the main
+settings, writes a commented `cli-wizard.yaml`, and generates a basic CLI from
+it, without API commands. The CLI lands in the current directory, in a
+directory named after `CommandName`; pass `--output` to write it elsewhere:
+
+```shell
+cli-wizard bootstrap --configuration cli-wizard.yaml
+```
+
+Then edit the configuration, point `Api` at your specification, and rebuild
+with `cli-wizard generate --configuration cli-wizard.yaml`.
+
+## Configuration
+
+See [configuration reference](https://gmarciani.github.io/cli-wizard/configuration.html) for full documentation.
+See the [examples](examples/) directory for complete configuration examples.
+
+## Commands
+
+### cli-wizard generate
+
+Generate a CLI from an OpenAPI specification, with an optional configuration file.
+
+```shell
+cli-wizard generate [OPTIONS]
+```
+
+Options:
+- `--api, -a` - Path to the OpenAPI spec file, YAML or JSON. Without it and without `Api` in the configuration, the CLI is generated without API commands
+- `--configuration, -c` - Path to the `cli-wizard.yaml` configuration file. Without it, every parameter takes its default
+- `--project-name, -p` - Human-readable project name; the generated command name derives from it, unless the configuration sets it
+- `--output, -o` - Output directory (default: a directory named after `CommandName` in the current directory)
+- `--force, -f` - Skip the confirmation prompt when the output directory is not empty
+
+### cli-wizard bootstrap
+
+Bootstrap a new CLI project interactively, without an OpenAPI specification.
+It does two things: it writes a configuration file to evolve the project from,
+then generates a basic CLI from that file, without API commands, in the output
+directory.
+
+```shell
+cli-wizard bootstrap [OPTIONS]
+```
+
+Options:
+- `--configuration, -c` - Path for the `cli-wizard.yaml` configuration file (default: `./cli-wizard.yaml`). An existing file is overwritten, after confirmation, without keeping any of its values
+- `--output, -o` - Output directory of the basic CLI (default: a directory named after `CommandName` in the current directory)
+- `--force, -f` - Skip the confirmation prompts to overwrite an existing configuration file or to write into a non-empty directory
+
+## Issues
+
+Please report any issues or feature requests on the [GitHub Issues](https://github.com/gmarciani/cli-wizard/issues) page.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/gmarciani/cli-wizard/blob/main/LICENSE) file for details.

cli_wizard-3.0.0/VERSION

@@ -0,0 +1 @@
+3.0.0

cli_wizard-3.0.0/pyproject.toml

@@ -0,0 +1,117 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cli-wizard"
+dynamic = ["version"]
+description = "Generate modern CLIs from OpenAPI specifications"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Giacomo Marciani", email = "giacomo.marciani@gmail.com"}
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "click~=8.4",
+    "Jinja2~=3.1",
+    "pydantic~=2.13",
+    "PyYAML~=6.0",
+    "requests~=2.34",
+    "ruff~=0.16.2",
+]
+
+[project.scripts]
+cli-wizard = "cli_wizard.cli:main"
+
+[project.urls]
+Homepage = "https://gmarciani.github.io/cli-wizard/"
+Repository = "https://github.com/gmarciani/cli-wizard"
+Issues = "https://github.com/gmarciani/cli-wizard/issues"
+
+# Local-only tooling (PEP 735). Groups are never published, so none of this
+# reaches anyone installing cli-wizard from an index. There are no extras: the
+# built distributions carry no tests, so a published test extra would only
+# install pytest for a consumer with nothing to run it against.
+[dependency-groups]
+dev = [
+    {include-group = "test"},
+    {include-group = "docs"},
+    "build~=1.5",
+    "pre-commit~=4.6",
+    "tox~=4.58",
+    "twine>=6.2,<8.0",
+]
+# mypy and the stubs too: the suite type checks the code it generates.
+test = [
+    "mypy~=2.3",
+    "pytest~=9.1",
+    "pytest-cov~=7.1",
+    "types-PyYAML~=6.0",
+    "types-requests~=2.33",
+]
+docs = [
+    "sphinx~=9.1",
+    "sphinx-click~=6.2",
+    "sphinx-rtd-theme~=3.1",
+    "sphinx-new-tab-link~=0.8",
+    "autodoc_pydantic~=2.2",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["cli_wizard*"]
+
+[tool.setuptools.package-data]
+cli_wizard = [
+    "templates/**/*.j2",
+    "templates/**/*.yaml",
+    "templates/**/*.yml",
+    "templates/**/*.md",
+    "config/*.yaml",
+]
+
+[tool.setuptools.dynamic]
+version = {file = "VERSION"}
+
+# Ruff targets the oldest supported version: it emits syntax valid for the
+# target, and newer syntax would be a SyntaxError on 3.12.
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+# E/W pycodestyle, F pyflakes, I isort, B bugbear, S bandit, UP pyupgrade
+select = ["E", "F", "W", "I", "B", "S", "UP"]
+
+[tool.ruff.lint.per-file-ignores]
+# Tests assert by design.
+"tests/**" = ["S101"]
+
+# mypy checks against the default interpreter, the newest supported version.
+[tool.mypy]
+python_version = "3.14"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.coverage.run]
+omit = ["*/__init__.py"]
+
+[tool.coverage.report]
+fail_under = 90
+
+[tool.pytest.ini_options]
+# Import cli_wizard from the checkout being tested. The editable install names
+# one checkout in its .pth file, so a run started from a git worktree would
+# otherwise import that other checkout.
+pythonpath = ["src"]

cli_wizard-3.0.0/src/cli_wizard/cli.py

@@ -0,0 +1,67 @@
+# Copyright (c) 2026, Giacomo Marciani
+# Licensed under the MIT License
+
+"""Main CLI module for CLI Wizard."""
+
+import logging
+import traceback
+from typing import Any
+
+import click
+
+from cli_wizard.commands.bootstrap import bootstrap
+from cli_wizard.commands.common import configure_logging, debug_option
+from cli_wizard.commands.config import config
+from cli_wizard.commands.generate import generate
+from cli_wizard.constants import __version__
+from cli_wizard.errors import UnexpectedError, reported
+
+logger = logging.getLogger(__name__)
+
+
+class RootGroup(click.Group):
+    """The root group, reporting what Click raises on its own as JSON too.
+
+    Click's main() shows a ClickException and exits with its code; wrapping the
+    parsing and the dispatch turns everything else into one of cli-wizard's
+    errors first, so every failure is the one JSON document on stdout.
+    """
+
+    def make_context(
+        self,
+        info_name: str | None,
+        args: list[str],
+        parent: click.Context | None = None,
+        **extra: Any,
+    ) -> click.Context:
+        with reported():
+            return super().make_context(info_name, args, parent, **extra)
+
+    def invoke(self, ctx: click.Context) -> Any:
+        try:
+            with reported():
+                return super().invoke(ctx)
+        except UnexpectedError as e:
+            # The traceback the bug came with, kept for --debug
+            logger.debug("".join(traceback.format_exception(e.__cause__)))
+            raise
+
+
+@click.group(cls=RootGroup, help="CLI Wizard - Generate modern CLI from OpenAPI.")
+@click.version_option(version=__version__, prog_name="cli-wizard")
+@debug_option
+@click.pass_context
+def main(ctx: click.Context, debug: bool) -> None:
+    """Main CLI entry point."""
+    ctx.ensure_object(dict)
+    ctx.obj["debug"] = debug
+    configure_logging(debug)
+
+
+main.add_command(bootstrap)
+main.add_command(config)
+main.add_command(generate)
+
+
+if __name__ == "__main__":
+    main()