fastapi-openapi-cli 0.1.0__tar.gz

fastapi_openapi_cli-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.3
+Name: fastapi-openapi-cli
+Version: 0.1.0
+Summary: CLI tool to export FastAPI OpenAPI specifications
+Author: Hector Castro
+Author-email: Hector Castro <hectcastro@gmail.com>
+License: Apache-2.0
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: typer>=0.15.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# fastapi-openapi-cli
+
+A command-line tool to export OpenAPI specifications from FastAPI applications.
+
+## Installation
+
+```bash
+uv add fastapi-openapi-cli
+```
+
+## Usage
+
+### Basic Usage
+
+Export OpenAPI spec to `stdout`:
+
+```bash
+fastapi-openapi --app myapp.main:app
+```
+
+Export to JSON File:
+
+```bash
+fastapi-openapi --app myapp.main:app -o openapi.json
+```
+
+Export to YAML File:
+
+```bash
+fastapi-openapi --app myapp.main:app -o openapi.yaml
+```
+
+## Development
+
+### Setup
+
+This project uses [uv](https://github.com/astral-sh/uv) for dependency management:
+
+```bash
+# Clone the repository
+git clone https://github.com/hectcastro/fastapi-openapi-cli.git
+cd fastapi-openapi-cli
+
+# Install dependencies
+uv sync
+```
+
+### Running Tests
+
+```bash
+# Run all tests with coverage
+make test
+
+# Run specific test file
+uv run pytest tests/test_cli.py
+
+# Run without coverage
+uv run pytest --no-cov
+```
+
+### Linting and Formatting
+
+```bash
+# Check code with ruff
+make lint
+
+# Format code
+make format
+```
+
+### Type Checking
+
+```bash
+# Run type checking with ty
+make types
+```
+
+### Dependency Analysis
+
+```bash
+# Check for dependency issues with deptry
+make deps
+```
+
+### CI Pipeline
+
+```bash
+# Run all checks (lint, types, tests) - same as CI
+make ci
+```
+
+### Running the CLI Locally
+
+```bash
+# Run the CLI in development
+uv run fastapi-openapi --app tests.fixtures.sample_app:app
+```

fastapi_openapi_cli-0.1.0/README.md

@@ -0,0 +1,97 @@
+# fastapi-openapi-cli
+
+A command-line tool to export OpenAPI specifications from FastAPI applications.
+
+## Installation
+
+```bash
+uv add fastapi-openapi-cli
+```
+
+## Usage
+
+### Basic Usage
+
+Export OpenAPI spec to `stdout`:
+
+```bash
+fastapi-openapi --app myapp.main:app
+```
+
+Export to JSON File:
+
+```bash
+fastapi-openapi --app myapp.main:app -o openapi.json
+```
+
+Export to YAML File:
+
+```bash
+fastapi-openapi --app myapp.main:app -o openapi.yaml
+```
+
+## Development
+
+### Setup
+
+This project uses [uv](https://github.com/astral-sh/uv) for dependency management:
+
+```bash
+# Clone the repository
+git clone https://github.com/hectcastro/fastapi-openapi-cli.git
+cd fastapi-openapi-cli
+
+# Install dependencies
+uv sync
+```
+
+### Running Tests
+
+```bash
+# Run all tests with coverage
+make test
+
+# Run specific test file
+uv run pytest tests/test_cli.py
+
+# Run without coverage
+uv run pytest --no-cov
+```
+
+### Linting and Formatting
+
+```bash
+# Check code with ruff
+make lint
+
+# Format code
+make format
+```
+
+### Type Checking
+
+```bash
+# Run type checking with ty
+make types
+```
+
+### Dependency Analysis
+
+```bash
+# Check for dependency issues with deptry
+make deps
+```
+
+### CI Pipeline
+
+```bash
+# Run all checks (lint, types, tests) - same as CI
+make ci
+```
+
+### Running the CLI Locally
+
+```bash
+# Run the CLI in development
+uv run fastapi-openapi --app tests.fixtures.sample_app:app
+```

fastapi_openapi_cli-0.1.0/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "fastapi-openapi-cli"
+version = "0.1.0"
+description = "CLI tool to export FastAPI OpenAPI specifications"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Hector Castro", email = "hectcastro@gmail.com" }]
+requires-python = ">=3.12"
+dependencies = ["fastapi>=0.115.0", "typer>=0.15.0", "pyyaml>=6.0.2"]
+
+[project.scripts]
+fastapi-openapi = "fastapi_openapi_cli.cli:app"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.0",
+    "pytest-cov>=6.0.0",
+    "ruff>=0.8.0",
+    "ty>=0.0.1a25",
+    "deptry>=0.21.0",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.7,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+lint.select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "SIM", # flake8-simplify
+    "TC",  # flake8-type-checking
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+addopts = [
+    "--cov=fastapi_openapi_cli",
+    "--cov-report=term-missing",
+    "--cov-report=html",
+    "--cov-fail-under=100",
+]
+
+[tool.coverage.run]
+source = ["src"]
+omit = ["*/tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+
+[tool.deptry]
+extend_exclude = ["tests"]
+known_first_party = ["fastapi_openapi_cli"]

fastapi_openapi_cli-0.1.0/src/fastapi_openapi_cli/cli.py

@@ -0,0 +1,31 @@
+import typer
+
+from fastapi_openapi_cli.export import export_openapi
+from fastapi_openapi_cli.loader import AppLoadError, load_app
+
+app = typer.Typer(
+    name="fastapi-openapi",
+    help="CLI tool to export FastAPI OpenAPI specifications",
+    no_args_is_help=True,
+)
+
+
+@app.command()
+def export(
+    app_path: str = typer.Option(..., "--app", "-a", help="FastAPI app path (e.g., module:app)"),
+    output: str | None = typer.Option(
+        None, "--output", "-o", help="Output file path (default: stdout)"
+    ),
+) -> None:
+    """
+    Export the OpenAPI specification from a FastAPI application.
+
+    Supports both JSON and YAML formats. Format is auto-detected from file extension.
+    If no output file is specified, outputs JSON to stdout.
+    """
+    try:
+        fastapi_app = load_app(app_path)
+        export_openapi(fastapi_app, output)
+    except AppLoadError as e:
+        typer.echo(str(e), err=True)
+        raise typer.Exit(code=1) from e

fastapi_openapi_cli-0.1.0/src/fastapi_openapi_cli/export.py

@@ -0,0 +1,26 @@
+import json
+from pathlib import Path
+
+import yaml
+from fastapi import FastAPI
+
+
+def get_openapi_spec(app: FastAPI) -> dict:
+    return app.openapi()
+
+
+def export_openapi(app: FastAPI, output_path: str | None) -> None:
+    spec = get_openapi_spec(app)
+
+    if output_path is None:
+        print(json.dumps(spec, indent=2))
+        return
+
+    output_file = Path(output_path)
+
+    if output_file.suffix in {".yaml", ".yml"}:
+        with output_file.open("w") as f:
+            yaml.safe_dump(spec, f, sort_keys=False)
+    else:
+        with output_file.open("w") as f:
+            json.dump(spec, f, indent=2)

fastapi_openapi_cli-0.1.0/src/fastapi_openapi_cli/loader.py

@@ -0,0 +1,28 @@
+import importlib
+
+from fastapi import FastAPI
+
+
+class AppLoadError(Exception):
+    pass
+
+
+def load_app(app_path: str) -> FastAPI:
+    module_path, app_name = app_path.split(":")
+
+    try:
+        module = importlib.import_module(module_path)
+    except ModuleNotFoundError as e:
+        raise AppLoadError(f"Could not import module '{module_path}': {e}") from e
+
+    try:
+        app = getattr(module, app_name)
+    except AttributeError as e:
+        raise AppLoadError(f"Module '{module_path}' has no attribute '{app_name}'") from e
+
+    if not isinstance(app, FastAPI):
+        raise AppLoadError(
+            f"Attribute '{app_name}' in module '{module_path}' is not a FastAPI instance"
+        )
+
+    return app