doc changes from fastapi openapi first to openapi first. added cli docs

docs/openapi_first/cli.md

@@ -0,0 +1,3 @@
+# Cli
+
+::: openapi_first.cli

mkdocs.yml

@@ -41,7 +41,10 @@ nav:
   - Core:
       - OpenAPI-First App: openapi_first/app.md
       - Route Binder: openapi_first/binder.md
-      - Spec Loaders: openapi_first/loaders.md
+      - Spec Loaders: openapi_first/loader.md
+
+  - CLI:
+      - Home: openapi_first/cli.md
 
   - Errors:
       - Error Hierarchy: openapi_first/errors.md

openapi_first/__init__.py

@@ -33,11 +33,11 @@ Installation
 
 Install using pip:
 
-    pip install fastapi-openapi-first
+    pip install openapi-first
 
 Or with Poetry:
 
-    poetry add fastapi-openapi-first
+    poetry add openapi-first
 
 Runtime dependencies are intentionally minimal:
 - fastapi
@@ -53,7 +53,7 @@ Basic Usage
 
 Minimal OpenAPI-first FastAPI application:
 
-    from fastapi_openapi_first import app
+    from openapi_first import app
     import my_service.routes as routes
 
     api = app.OpenAPIFirstApp(
@@ -104,10 +104,10 @@ Public API Surface
 
 The supported public API consists of the following top-level modules:
 
-- fastapi_openapi_first.app
+- openapi_first.app
-- fastapi_openapi_first.binder
+- openapi_first.binder
-- fastapi_openapi_first.loader
+- openapi_first.loader
-- fastapi_openapi_first.errors
+- openapi_first.errors
 
 Classes and functions should be imported explicitly from these modules.
 No individual symbols are re-exported at the package root.

openapi_first/app.py

@@ -1,5 +1,5 @@
 """
-fastapi_openapi_first.app
+openapi_first.app
 =========================
 
 OpenAPI-first application bootstrap for FastAPI.
@@ -84,7 +84,7 @@ class OpenAPIFirstApp(FastAPI):
 
     Example
     -------
-    >>> from fastapi_openapi_first import OpenAPIFirstApp
+    >>> from openapi_first import OpenAPIFirstApp
     >>> import app.routes as routes
     >>>
     >>> app = OpenAPIFirstApp(

openapi_first/binder.py

@@ -1,5 +1,5 @@
 """
-fastapi_openapi_first.binder
+openapi_first.binder
 ============================
 
 OpenAPI-driven route binding for FastAPI.

openapi_first/cli.py

@@ -1,21 +1,79 @@
-import shutil
+"""
+openapi_first.cli
+========================
+
+Command-line interface for FastAPI OpenAPI-first scaffolding utilities.
+
+This module provides a small, focused CLI intended to help developers
+quickly bootstrap OpenAPI-first FastAPI services using bundled project
+templates.
+
+Currently supported scaffolds:
+- Health check service (minimal OpenAPI-first application)
+
+The CLI copies versioned templates packaged with the library into a
+user-specified directory, allowing rapid local development without
+manual setup.
+"""
+
 import argparse
+import shutil
 from pathlib import Path
 from importlib import resources
 
 
 def copy_health_app_template(target_dir: Path) -> None:
     """
-    Copy the bundled health app template into a target directory.
+    Copy the bundled OpenAPI-first health app template into a directory.
+
+    This function copies a fully working, minimal OpenAPI-first FastAPI
+    health check application from the package's embedded templates into
+    the specified target directory.
+
+    The target directory will be created if it does not already exist.
+    Existing files may be overwritten.
+
+    Parameters
+    ----------
+    target_dir : pathlib.Path
+        Destination directory into which the health app template
+        should be copied.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the bundled health app template cannot be located.
     """
     target_dir = target_dir.resolve()
     target_dir.mkdir(parents=True, exist_ok=True)
 
-    with resources.files("fastapi_openapi_first.templates").joinpath("health_app") as src:
+    with resources.files("openapi_first.templates").joinpath(
+        "health_app"
+    ) as src:
         shutil.copytree(src, target_dir, dirs_exist_ok=True)
 
 
-def main():
+def main() -> None:
+    """
+    Entry point for the FastAPI OpenAPI-first CLI.
+
+    Parses command-line arguments and initializes a new OpenAPI-first
+    health check application by copying the bundled template into the
+    specified directory.
+
+    If no target path is provided, the scaffold is created in a directory
+    named ``health-app`` in the current working directory.
+
+    Example
+    -------
+    Create a health app in the default directory::
+
+        openapi-first
+
+    Create a health app in a custom directory::
+
+        openapi-first my-service
+    """
     parser = argparse.ArgumentParser(
         description="FastAPI OpenAPI-first scaffolding tools"
     )

openapi_first/errors.py

@@ -1,5 +1,5 @@
 """
-fastapi_openapi_first.errors
+openapi_first.errors
 ============================
 
 Custom exceptions for OpenAPI-first FastAPI applications.

openapi_first/loader.py

@@ -1,5 +1,5 @@
 """
-fastapi_openapi_first.loaders
+openapi_first.loaders
 =============================
 
 OpenAPI specification loading and validation utilities.