cli-wizard 1.0.0__tar.gz

cli_wizard-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Giacomo Marciani
+
+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.

cli_wizard-1.0.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+recursive-include src/cli_wizard *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

cli_wizard-1.0.0/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: cli-wizard
+Version: 1.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: Repository, https://github.com/gmarciani/cli-wizard
+Project-URL: Issues, https://github.com/gmarciani/cli-wizard/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click~=8.1
+Requires-Dist: Jinja2~=3.1
+Requires-Dist: pydantic~=2.10
+Requires-Dist: PyYAML~=6.0
+Requires-Dist: requests~=2.32
+Provides-Extra: dev
+Requires-Dist: autoflake~=2.3; extra == "dev"
+Requires-Dist: black~=26.1; extra == "dev"
+Requires-Dist: build~=1.3; extra == "dev"
+Requires-Dist: flake8~=7.3; extra == "dev"
+Requires-Dist: mypy~=1.18; extra == "dev"
+Requires-Dist: pre-commit~=4.0; extra == "dev"
+Requires-Dist: pytest~=9.0; extra == "dev"
+Requires-Dist: pytest-cov~=7.0; extra == "dev"
+Requires-Dist: tox~=4.32; 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.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme~=3.0; extra == "docs"
+Dynamic: license-file
+
+# CLI WIZARD
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/gmarciani/cli-wizard/main/resources/brand/logo.png" alt="cli-wizard-logo" 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/)
+[![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.yml?branch=main)](https://github.com/gmarciani/cli-wizard/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/gmarciani/cli-wizard/test.yml?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)
+[![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
+- 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`, `README.md`, and `VERSION`
+- 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: Create a Configuration File
+
+Create a `config.yaml` file with your CLI settings. At minimum, you need `PackageName` and `DefaultBaseUrl`:
+
+```yaml
+# Required parameters
+PackageName: "my-cli"
+DefaultBaseUrl: "https://api.example.com"
+
+# Optional: customize the splash screen
+SplashFile: "splash.txt"
+SplashColor: "#00FFFF"
+
+# Optional: filter which tags to include
+IncludeTags:
+  - Users
+  - Products
+```
+
+### Step 3: Generate the CLI
+
+Run the `generate` command:
+
+```shell
+cli-wizard generate --openapi openapi.yaml --config config.yaml --output my-cli
+```
+
+This creates a complete Python CLI project in the `my-cli` directory.
+
+### Step 4: Install the Generated CLI
+
+Navigate to the generated project and install it:
+
+```shell
+pip install -e my-cli
+```
+
+### Step 5: Use Your CLI
+
+Your CLI is now ready to use:
+
+```shell
+my-cli --help
+my-cli users list-users
+```
+
+## Configuration
+
+Configuration uses a YAML file with PascalCase parameter names. You can reference other parameters with `#[ParamName]` syntax and environment variables with `${VAR}` syntax.
+
+### Required Parameters
+
+| Parameter | Description |
+|-----------|-------------|
+| `PackageName` | Python package name for the generated CLI |
+| `DefaultBaseUrl` | Default API base URL |
+
+### Common Parameters
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `OutputDir` | `#[PackageName]` | Output directory for the generated CLI project |
+| `MainDir` | `${HOME}/.#[PackageName]` | Main directory for CLI data (config, cache, logs) |
+| `ProfileFile` | `#[MainDir]/profiles.yaml` | Path to profiles YAML file |
+| `ExcludeTags` | `[]` | Tags to exclude from generation |
+| `IncludeTags` | `[]` | Tags to include (empty means all) |
+| `TagMapping` | `{}` | Map OpenAPI tags to CLI command group names |
+| `CommandMapping` | `{}` | Customize command names (operationId → command name) |
+| `SplashFile` | `None` | Path to splash text file |
+| `SplashColor` | `#FFFFFF` | Color for splash text (hex code) |
+| `Timeout` | `30` | Request timeout in seconds |
+| `CaFile` | `None` | CA certificate file for SSL verification |
+
+### Logging Parameters
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `LogLevel` | `INFO` | Default log level (DEBUG, INFO, WARNING, ERROR) |
+| `LogFormat` | `[%(levelname)s] %(asctime)s %(message)s` | Log message format |
+| `LogFile` | `None` | Path to log file (None means console only) |
+| `LogRotationType` | `days` | Log rotation type: `size` or `days` |
+| `LogRotationDays` | `30` | Log rotation interval in days |
+| `LogColorStyle` | `level` | Color style: `full` or `level` |
+
+See the [examples](examples/) directory for complete configuration examples.
+
+## Commands
+
+### cli-wizard generate
+
+Generate a CLI from an OpenAPI specification and 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: `config.yaml`)
+- `--output, -d` - Output directory for generated CLI (default: `cli`)
+- `--working-dir, -w` - Working directory for resolving relative paths
+
+## 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](LICENSE) file for details.

cli_wizard-1.0.0/README.md

@@ -0,0 +1,193 @@
+# CLI WIZARD
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/gmarciani/cli-wizard/main/resources/brand/logo.png" alt="cli-wizard-logo" 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/)
+[![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.yml?branch=main)](https://github.com/gmarciani/cli-wizard/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/gmarciani/cli-wizard/test.yml?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)
+[![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
+- 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`, `README.md`, and `VERSION`
+- 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: Create a Configuration File
+
+Create a `config.yaml` file with your CLI settings. At minimum, you need `PackageName` and `DefaultBaseUrl`:
+
+```yaml
+# Required parameters
+PackageName: "my-cli"
+DefaultBaseUrl: "https://api.example.com"
+
+# Optional: customize the splash screen
+SplashFile: "splash.txt"
+SplashColor: "#00FFFF"
+
+# Optional: filter which tags to include
+IncludeTags:
+  - Users
+  - Products
+```
+
+### Step 3: Generate the CLI
+
+Run the `generate` command:
+
+```shell
+cli-wizard generate --openapi openapi.yaml --config config.yaml --output my-cli
+```
+
+This creates a complete Python CLI project in the `my-cli` directory.
+
+### Step 4: Install the Generated CLI
+
+Navigate to the generated project and install it:
+
+```shell
+pip install -e my-cli
+```
+
+### Step 5: Use Your CLI
+
+Your CLI is now ready to use:
+
+```shell
+my-cli --help
+my-cli users list-users
+```
+
+## Configuration
+
+Configuration uses a YAML file with PascalCase parameter names. You can reference other parameters with `#[ParamName]` syntax and environment variables with `${VAR}` syntax.
+
+### Required Parameters
+
+| Parameter | Description |
+|-----------|-------------|
+| `PackageName` | Python package name for the generated CLI |
+| `DefaultBaseUrl` | Default API base URL |
+
+### Common Parameters
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `OutputDir` | `#[PackageName]` | Output directory for the generated CLI project |
+| `MainDir` | `${HOME}/.#[PackageName]` | Main directory for CLI data (config, cache, logs) |
+| `ProfileFile` | `#[MainDir]/profiles.yaml` | Path to profiles YAML file |
+| `ExcludeTags` | `[]` | Tags to exclude from generation |
+| `IncludeTags` | `[]` | Tags to include (empty means all) |
+| `TagMapping` | `{}` | Map OpenAPI tags to CLI command group names |
+| `CommandMapping` | `{}` | Customize command names (operationId → command name) |
+| `SplashFile` | `None` | Path to splash text file |
+| `SplashColor` | `#FFFFFF` | Color for splash text (hex code) |
+| `Timeout` | `30` | Request timeout in seconds |
+| `CaFile` | `None` | CA certificate file for SSL verification |
+
+### Logging Parameters
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `LogLevel` | `INFO` | Default log level (DEBUG, INFO, WARNING, ERROR) |
+| `LogFormat` | `[%(levelname)s] %(asctime)s %(message)s` | Log message format |
+| `LogFile` | `None` | Path to log file (None means console only) |
+| `LogRotationType` | `days` | Log rotation type: `size` or `days` |
+| `LogRotationDays` | `30` | Log rotation interval in days |
+| `LogColorStyle` | `level` | Color style: `full` or `level` |
+
+See the [examples](examples/) directory for complete configuration examples.
+
+## Commands
+
+### cli-wizard generate
+
+Generate a CLI from an OpenAPI specification and 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: `config.yaml`)
+- `--output, -d` - Output directory for generated CLI (default: `cli`)
+- `--working-dir, -w` - Working directory for resolving relative paths
+
+## 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](LICENSE) file for details.

cli_wizard-1.0.0/VERSION

@@ -0,0 +1 @@
+1.0.0

cli_wizard-1.0.0/pyproject.toml

@@ -0,0 +1,82 @@
+[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.1",
+    "Jinja2~=3.1",
+    "pydantic~=2.10",
+    "PyYAML~=6.0",
+    "requests~=2.32",
+]
+
+[project.optional-dependencies]
+dev = [
+    "autoflake~=2.3",
+    "black~=26.1",
+    "build~=1.3",
+    "flake8~=7.3",
+    "mypy~=1.18",
+    "pre-commit~=4.0",
+    "pytest~=9.0",
+    "pytest-cov~=7.0",
+    "tox~=4.32",
+    "twine~=6.2",
+    "types-PyYAML~=6.0",
+    "types-requests~=2.32",
+]
+docs = [
+    "sphinx~=9.1",
+    "sphinx-click~=6.0",
+    "sphinx-rtd-theme~=3.0",
+]
+
+[project.scripts]
+cli-wizard = "cli_wizard.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/gmarciani/cli-wizard"
+Repository = "https://github.com/gmarciani/cli-wizard"
+Issues = "https://github.com/gmarciani/cli-wizard/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["cli_wizard*"]
+
+[tool.setuptools.package-data]
+cli_wizard = ["templates/*.j2", "config/*.yaml"]
+
+[tool.setuptools.dynamic]
+version = {file = "VERSION"}
+
+[tool.black]
+line-length = 88
+target-version = ['py311']
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.coverage.run]
+omit = ["*/__init__.py"]

cli_wizard-1.0.0/setup.cfg

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

cli_wizard-1.0.0/src/cli_wizard/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (c) 2026, Giacomo Marciani
+# Licensed under the MIT License
+
+"""CLI Wizard - Build modern CLI from OpenAPI"""

cli_wizard-1.0.0/src/cli_wizard/cli.py

@@ -0,0 +1,37 @@
+# Copyright (c) 2026, Giacomo Marciani
+# Licensed under the MIT License
+
+"""Main CLI module for CLI Wizard."""
+
+import click
+import logging
+from cli_wizard.constants import __version__
+from cli_wizard.commands.config import config
+from cli_wizard.commands.generate import generate
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name="cli-wizard")
+@click.option("--debug", "-d", is_flag=True, help="Enable debug output")
+@click.pass_context
+def main(ctx: click.Context, debug: bool) -> None:
+    """CLI Wizard - Generate modern CLI from OpenAPI."""
+    ctx.ensure_object(dict)
+    ctx.obj["debug"] = debug
+
+    # Configure logging
+    level = logging.DEBUG if debug else logging.INFO
+    logging.basicConfig(
+        level=level,
+        format="%(asctime)s %(levelname)s: %(message)s",
+        datefmt="%Y-%m-%dT%H:%M:%SZ",
+    )
+    logging.Formatter.converter = lambda *args: __import__("time").gmtime()
+
+
+main.add_command(config)
+main.add_command(generate)
+
+
+if __name__ == "__main__":
+    main()

cli_wizard-1.0.0/src/cli_wizard/commands/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (c) 2026, Giacomo Marciani
+# Licensed under the MIT License
+
+"""Commands package for CLI Wizard."""

cli_wizard-1.0.0/src/cli_wizard/commands/common.py

@@ -0,0 +1,36 @@
+# Copyright (c) 2026, Giacomo Marciani
+# Licensed under the MIT License
+
+"""Common utilities for CLI Wizard commands."""
+
+import click
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def configure_logging(debug: bool = False) -> None:
+    """Configure logging with UTC timestamps.
+
+    Args:
+        debug: Whether to enable debug level logging
+    """
+    import time
+
+    for handler in logging.root.handlers[:]:
+        logging.root.removeHandler(handler)
+    level = logging.DEBUG if debug else logging.INFO
+    logging.basicConfig(
+        level=level,
+        format="%(asctime)s %(levelname)s: %(message)s",
+        datefmt="%Y-%m-%dT%H:%M:%SZ",
+    )
+    logging.Formatter.converter = time.gmtime
+
+
+debug_option = click.option(
+    "--debug",
+    "-d",
+    is_flag=True,
+    help="Enable debug output",
+)