fastapi-cli 0.0.5__tar.gz → 0.0.6__tar.gz

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/PKG-INFO

@@ -1,8 +1,7 @@
 Metadata-Version: 2.1
 Name: fastapi-cli
-Version: 0.0.5
+Version: 0.0.6
 Summary: Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
-Home-page: https://github.com/fastapi/fastapi-cli
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 License: MIT
 Classifier: Intended Audience :: Information Technology
@@ -26,14 +25,17 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
-Project-URL: Documentation, https://fastapi.tiangolo.com
 Project-URL: Homepage, https://github.com/fastapi/fastapi-cli
+Project-URL: Documentation, https://fastapi.tiangolo.com/fastapi-cli/
 Project-URL: Repository, https://github.com/fastapi/fastapi-cli
+Project-URL: Issues, https://github.com/fastapi/fastapi-cli/issues
+Project-URL: Changelog, https://github.com/fastapi/fastapi-cli/blob/main/release-notes.md
 Requires-Python: >=3.8
 Requires-Dist: typer>=0.12.3
 Requires-Dist: uvicorn[standard]>=0.15.0
-Requires-Dist: uvicorn[standard]>=0.15.0; extra == "standard"
+Requires-Dist: rich-toolkit>=0.11.1
 Provides-Extra: standard
+Requires-Dist: uvicorn[standard]>=0.15.0; extra == "standard"
 Description-Content-Type: text/markdown
 
 # FastAPI CLI
@@ -70,46 +72,33 @@ To run your FastAPI app for development, you can use the `fastapi dev` command:
 
 ```console
 $ fastapi dev main.py
-INFO     Using path main.py
-INFO     Resolved absolute path /home/user/code/awesomeapp/main.py
-INFO     Searching for package file structure from directories with __init__.py files
-INFO     Importing from /home/user/code/awesomeapp
-
- ╭─ Python module file ─╮
- │                      │
- │  🐍 main.py          │
- │                      │
- ╰──────────────────────╯
-
-INFO     Importing module main
-INFO     Found importable FastAPI app
-
- ╭─ Importable FastAPI app ─╮
- │                          │
- │  from main import app    │
- │                          │
- ╰──────────────────────────╯
-
-INFO     Using import string main:app
-
- ╭────────── FastAPI CLI - Development mode ───────────╮
- │                                                     │
- │  Serving at: http://127.0.0.1:8000                  │
- │                                                     │
- │  API docs: http://127.0.0.1:8000/docs               │
- │                                                     │
- │  Running in development mode, for production use:   │
- │                                                     │
- │  fastapi run                                        │
- │                                                     │
- ╰─────────────────────────────────────────────────────╯
-
-INFO:     Will watch for changes in these directories: ['/home/user/code/awesomeapp']
-INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
-INFO:     Started reloader process [56345] using WatchFiles
-INFO:     Started server process [56352]
-INFO:     Waiting for application startup.
-INFO:     Application startup complete.
+
+   FastAPI   Starting development server 🚀
+
+             Searching for package file structure from directories with __init__.py files
+             Importing from /home/user/code/awesomeapp
+
+    module   🐍 main.py
+
+      code   Importing the FastAPI app object from the module with the following code:
+
+             from main import app
+
+       app   Using import string: main:app
+
+    server   Server started at http://127.0.0.1:8000
+    server   Documentation at http://127.0.0.1:8000/docs
+
+       tip   Running in development mode, for production use: fastapi run
+
+             Logs:
+
+      INFO   Will watch for changes in these directories: ['/home/user/code/awesomeapp']
+      INFO   Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+      INFO   Started reloader process [4106097] using WatchFiles
+      INFO   Started server process [4106120]
+      INFO   Waiting for application startup.
+      INFO   Application startup complete.
 ```
 
 </div>

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/README.md

@@ -32,46 +32,33 @@ To run your FastAPI app for development, you can use the `fastapi dev` command:
 
 ```console
 $ fastapi dev main.py
-INFO     Using path main.py
-INFO     Resolved absolute path /home/user/code/awesomeapp/main.py
-INFO     Searching for package file structure from directories with __init__.py files
-INFO     Importing from /home/user/code/awesomeapp
-
- ╭─ Python module file ─╮
- │                      │
- │  🐍 main.py          │
- │                      │
- ╰──────────────────────╯
-
-INFO     Importing module main
-INFO     Found importable FastAPI app
-
- ╭─ Importable FastAPI app ─╮
- │                          │
- │  from main import app    │
- │                          │
- ╰──────────────────────────╯
-
-INFO     Using import string main:app
-
- ╭────────── FastAPI CLI - Development mode ───────────╮
- │                                                     │
- │  Serving at: http://127.0.0.1:8000                  │
- │                                                     │
- │  API docs: http://127.0.0.1:8000/docs               │
- │                                                     │
- │  Running in development mode, for production use:   │
- │                                                     │
- │  fastapi run                                        │
- │                                                     │
- ╰─────────────────────────────────────────────────────╯
-
-INFO:     Will watch for changes in these directories: ['/home/user/code/awesomeapp']
-INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
-INFO:     Started reloader process [56345] using WatchFiles
-INFO:     Started server process [56352]
-INFO:     Waiting for application startup.
-INFO:     Application startup complete.
+
+   FastAPI   Starting development server 🚀
+
+             Searching for package file structure from directories with __init__.py files
+             Importing from /home/user/code/awesomeapp
+
+    module   🐍 main.py
+
+      code   Importing the FastAPI app object from the module with the following code:
+
+             from main import app
+
+       app   Using import string: main:app
+
+    server   Server started at http://127.0.0.1:8000
+    server   Documentation at http://127.0.0.1:8000/docs
+
+       tip   Running in development mode, for production use: fastapi run
+
+             Logs:
+
+      INFO   Will watch for changes in these directories: ['/home/user/code/awesomeapp']
+      INFO   Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+      INFO   Started reloader process [4106097] using WatchFiles
+      INFO   Started server process [4106120]
+      INFO   Waiting for application startup.
+      INFO   Application startup complete.
 ```
 
 </div>

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/pyproject.toml

@@ -33,8 +33,9 @@ classifiers = [
 dependencies = [
     "typer >= 0.12.3",
     "uvicorn[standard] >= 0.15.0",
+    "rich-toolkit >= 0.11.1",
 ]
-version = "0.0.5"
+version = "0.0.6"
 
 [project.license]
 text = "MIT"
@@ -45,9 +46,11 @@ standard = [
 ]
 
 [project.urls]
-Documentation = "https://fastapi.tiangolo.com"
-homepage = "https://github.com/fastapi/fastapi-cli"
+Homepage = "https://github.com/fastapi/fastapi-cli"
+Documentation = "https://fastapi.tiangolo.com/fastapi-cli/"
 Repository = "https://github.com/fastapi/fastapi-cli"
+Issues = "https://github.com/fastapi/fastapi-cli/issues"
+Changelog = "https://github.com/fastapi/fastapi-cli/blob/main/release-notes.md"
 
 [project.scripts]
 fastapi = "fastapi_cli.cli:main"
@@ -91,11 +94,14 @@ source = [
     "tests",
 ]
 context = "${CONTEXT}"
+dynamic_context = "test_function"
 omit = [
     "tests/assets/*",
 ]
 
 [tool.coverage.report]
+show_missing = true
+sort = "-Cover"
 exclude_lines = [
     "pragma: no cover",
     "@overload",
@@ -103,6 +109,9 @@ exclude_lines = [
     "if TYPE_CHECKING:",
 ]
 
+[tool.coverage.html]
+show_contexts = true
+
 [tool.mypy]
 strict = true
 exclude = [

fastapi_cli-0.0.6/requirements-github-actions.txt

@@ -0,0 +1 @@
+smokeshow

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/requirements-tests.txt

@@ -2,7 +2,7 @@
 
 pytest >=4.4.0,<9.0.0
 coverage[toml] >=6.2,<8.0
-mypy ==1.11.1
+mypy ==1.13.0
 ruff ==0.5.5
 # Needed explicitly by fastapi-cli-slim
 fastapi-slim

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/requirements.txt

@@ -2,4 +2,4 @@
 
 -r requirements-tests.txt
 
-pre-commit >=2.17.0,<4.0.0
+pre-commit >=2.17.0,<5.0.0

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/scripts/format.sh

@@ -2,5 +2,5 @@
 set -x
 set -e
 
-ruff src tests scripts --fix
+ruff check src tests scripts --fix
 ruff format src tests scripts

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/scripts/test-cov-html.sh

@@ -5,5 +5,5 @@ set -x
 
 bash scripts/test.sh ${@}
 coverage combine
-coverage report --show-missing
+coverage report
 coverage html

fastapi_cli-0.0.6/src/fastapi_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.6"

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/src/fastapi_cli/cli.py

@@ -1,23 +1,23 @@
-from logging import getLogger
+import logging
 from pathlib import Path
-from typing import Any, Union
+from typing import Any, List, Union
 
 import typer
 from rich import print
-from rich.padding import Padding
-from rich.panel import Panel
+from rich.tree import Tree
 from typing_extensions import Annotated
 
-from fastapi_cli.discover import get_import_string
+from fastapi_cli.discover import get_import_data
 from fastapi_cli.exceptions import FastAPICLIException
 
 from . import __version__
 from .logging import setup_logging
+from .utils.cli import get_rich_toolkit, get_uvicorn_log_config
 
 app = typer.Typer(rich_markup_mode="rich")
 
-setup_logging()
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
+
 
 try:
     import uvicorn
@@ -39,15 +39,41 @@ def callback(
             "--version", help="Show the version and exit.", callback=version_callback
         ),
     ] = None,
+    verbose: bool = typer.Option(False, help="Enable verbose output"),
 ) -> None:
     """
     FastAPI CLI - The [bold]fastapi[/bold] command line app. 😎
 
     Manage your [bold]FastAPI[/bold] projects, run your FastAPI apps, and more.
 
-    Read more in the docs: [link]https://fastapi.tiangolo.com/fastapi-cli/[/link].
+    Read more in the docs: [link=https://fastapi.tiangolo.com/fastapi-cli/]https://fastapi.tiangolo.com/fastapi-cli/[/link].
     """
 
+    log_level = logging.DEBUG if verbose else logging.INFO
+
+    setup_logging(level=log_level)
+
+
+def _get_module_tree(module_paths: List[Path]) -> Tree:
+    root = module_paths[0]
+    name = f"🐍 {root.name}" if root.is_file() else f"📁 {root.name}"
+
+    root_tree = Tree(name)
+
+    if root.is_dir():
+        root_tree.add("[dim]🐍 __init__.py[/dim]")
+
+    tree = root_tree
+    for sub_path in module_paths[1:]:
+        sub_name = (
+            f"🐍 {sub_path.name}" if sub_path.is_file() else f"📁 {sub_path.name}"
+        )
+        tree = tree.add(sub_name)
+        if sub_path.is_dir():
+            tree.add("[dim]🐍 __init__.py[/dim]")
+
+    return root_tree
+
 
 def _run(
     path: Union[Path, None] = None,
@@ -61,43 +87,88 @@ def _run(
     app: Union[str, None] = None,
     proxy_headers: bool = False,
 ) -> None:
-    try:
-        use_uvicorn_app = get_import_string(path=path, app_name=app)
-    except FastAPICLIException as e:
-        logger.error(str(e))
-        raise typer.Exit(code=1) from None
-    serving_str = f"[dim]Serving at:[/dim] [link]http://{host}:{port}[/link]\n\n[dim]API docs:[/dim] [link]http://{host}:{port}/docs[/link]"
-
-    if command == "dev":
-        panel = Panel(
-            f"{serving_str}\n\n[dim]Running in development mode, for production use:[/dim] \n\n[b]fastapi run[/b]",
-            title="FastAPI CLI - Development mode",
-            expand=False,
-            padding=(1, 2),
-            style="black on yellow",
+    with get_rich_toolkit() as toolkit:
+        server_type = "development" if command == "dev" else "production"
+
+        toolkit.print_title(f"Starting {server_type} server 🚀", tag="FastAPI")
+        toolkit.print_line()
+
+        toolkit.print(
+            "Searching for package file structure from directories with [blue]__init__.py[/blue] files"
+        )
+
+        try:
+            import_data = get_import_data(path=path, app_name=app)
+        except FastAPICLIException as e:
+            toolkit.print_line()
+            toolkit.print(f"[error]{e}")
+            raise typer.Exit(code=1) from None
+
+        logger.debug(f"Importing from {import_data.module_data.extra_sys_path}")
+        logger.debug(f"Importing module {import_data.module_data.module_import_str}")
+
+        module_data = import_data.module_data
+        import_string = import_data.import_string
+
+        toolkit.print(f"Importing from {module_data.extra_sys_path}")
+        toolkit.print_line()
+
+        root_tree = _get_module_tree(module_data.module_paths)
+
+        toolkit.print(root_tree, tag="module")
+        toolkit.print_line()
+
+        toolkit.print(
+            "Importing the FastAPI app object from the module with the following code:",
+            tag="code",
         )
-    else:
-        panel = Panel(
-            f"{serving_str}\n\n[dim]Running in production mode, for development use:[/dim] \n\n[b]fastapi dev[/b]",
-            title="FastAPI CLI - Production mode",
-            expand=False,
-            padding=(1, 2),
-            style="green",
+        toolkit.print_line()
+        toolkit.print(
+            f"[underline]from [bold]{module_data.module_import_str}[/bold] import [bold]{import_data.app_name}[/bold]"
+        )
+        toolkit.print_line()
+
+        toolkit.print(
+            f"Using import string: [blue]{import_string}[/]",
+            tag="app",
+        )
+
+        url = f"http://{host}:{port}"
+        url_docs = f"{url}/docs"
+
+        toolkit.print_line()
+        toolkit.print(
+            f"Server started at [link={url}]{url}[/]",
+            f"Documentation at [link={url_docs}]{url_docs}[/]",
+            tag="server",
+        )
+
+        if command == "dev":
+            toolkit.print_line()
+            toolkit.print(
+                "Running in development mode, for production use: [bold]fastapi run[/]",
+                tag="tip",
+            )
+
+        if not uvicorn:
+            raise FastAPICLIException(
+                "Could not import Uvicorn, try running 'pip install uvicorn'"
+            ) from None
+
+        toolkit.print_line()
+        toolkit.print("Logs:")
+        toolkit.print_line()
+
+        uvicorn.run(
+            app=import_string,
+            host=host,
+            port=port,
+            reload=reload,
+            workers=workers,
+            root_path=root_path,
+            proxy_headers=proxy_headers,
+            log_config=get_uvicorn_log_config(),
         )
-    print(Padding(panel, 1))
-    if not uvicorn:
-        raise FastAPICLIException(
-            "Could not import Uvicorn, try running 'pip install uvicorn'"
-        ) from None
-    uvicorn.run(
-        app=use_uvicorn_app,
-        host=host,
-        port=port,
-        reload=reload,
-        workers=workers,
-        root_path=root_path,
-        proxy_headers=proxy_headers,
-    )
 
 
 @app.command()

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/src/fastapi_cli/discover.py

@@ -3,13 +3,7 @@ import sys
 from dataclasses import dataclass
 from logging import getLogger
 from pathlib import Path
-from typing import Union
-
-from rich import print
-from rich.padding import Padding
-from rich.panel import Panel
-from rich.syntax import Syntax
-from rich.tree import Tree
+from typing import List, Union
 
 from fastapi_cli.exceptions import FastAPICLIException
 
@@ -45,12 +39,10 @@ def get_default_path() -> Path:
 class ModuleData:
     module_import_str: str
     extra_sys_path: Path
+    module_paths: List[Path]
 
 
 def get_module_data_from_path(path: Path) -> ModuleData:
-    logger.info(
-        "Searching for package file structure from directories with [blue]__init__.py[/blue] files"
-    )
     use_path = path.resolve()
     module_path = use_path
     if use_path.is_file() and use_path.stem == "__init__":
@@ -64,37 +56,12 @@ def get_module_data_from_path(path: Path) -> ModuleData:
             extra_sys_path = parent.parent
         else:
             break
-    logger.info(f"Importing from {extra_sys_path.resolve()}")
-    root = module_paths[0]
-    name = f"🐍 {root.name}" if root.is_file() else f"📁 {root.name}"
-    root_tree = Tree(name)
-    if root.is_dir():
-        root_tree.add("[dim]🐍 __init__.py[/dim]")
-    tree = root_tree
-    for sub_path in module_paths[1:]:
-        sub_name = (
-            f"🐍 {sub_path.name}" if sub_path.is_file() else f"📁 {sub_path.name}"
-        )
-        tree = tree.add(sub_name)
-        if sub_path.is_dir():
-            tree.add("[dim]🐍 __init__.py[/dim]")
-    title = "[b green]Python module file[/b green]"
-    if len(module_paths) > 1 or module_path.is_dir():
-        title = "[b green]Python package file structure[/b green]"
-    panel = Padding(
-        Panel(
-            root_tree,
-            title=title,
-            expand=False,
-            padding=(1, 2),
-        ),
-        1,
-    )
-    print(panel)
+
     module_str = ".".join(p.stem for p in module_paths)
-    logger.info(f"Importing module [green]{module_str}[/green]")
     return ModuleData(
-        module_import_str=module_str, extra_sys_path=extra_sys_path.resolve()
+        module_import_str=module_str,
+        extra_sys_path=extra_sys_path.resolve(),
+        module_paths=module_paths,
     )
 
 
@@ -136,32 +103,30 @@ def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) ->
     raise FastAPICLIException("Could not find FastAPI app in module, try using --app")
 
 
-def get_import_string(
+@dataclass
+class ImportData:
+    app_name: str
+    module_data: ModuleData
+    import_string: str
+
+
+def get_import_data(
     *, path: Union[Path, None] = None, app_name: Union[str, None] = None
-) -> str:
+) -> ImportData:
     if not path:
         path = get_default_path()
-    logger.info(f"Using path [blue]{path}[/blue]")
-    logger.info(f"Resolved absolute path {path.resolve()}")
+
+    logger.debug(f"Using path [blue]{path}[/blue]")
+    logger.debug(f"Resolved absolute path {path.resolve()}")
+
     if not path.exists():
         raise FastAPICLIException(f"Path does not exist {path}")
     mod_data = get_module_data_from_path(path)
     sys.path.insert(0, str(mod_data.extra_sys_path))
     use_app_name = get_app_name(mod_data=mod_data, app_name=app_name)
-    import_example = Syntax(
-        f"from {mod_data.module_import_str} import {use_app_name}", "python"
-    )
-    import_panel = Padding(
-        Panel(
-            import_example,
-            title="[b green]Importable FastAPI app[/b green]",
-            expand=False,
-            padding=(1, 2),
-        ),
-        1,
-    )
-    logger.info("Found importable FastAPI app")
-    print(import_panel)
+
     import_string = f"{mod_data.module_import_str}:{use_app_name}"
-    logger.info(f"Using import string [b green]{import_string}[/b green]")
-    return import_string
+
+    return ImportData(
+        app_name=use_app_name, module_data=mod_data, import_string=import_string
+    )

{fastapi_cli-0.0.5 → fastapi_cli-0.0.6}/src/fastapi_cli/logging.py

@@ -5,7 +5,9 @@ from rich.console import Console
 from rich.logging import RichHandler
 
 
-def setup_logging(terminal_width: Union[int, None] = None) -> None:
+def setup_logging(
+    terminal_width: Union[int, None] = None, level: int = logging.INFO
+) -> None:
     logger = logging.getLogger("fastapi_cli")
     console = Console(width=terminal_width) if terminal_width else None
     rich_handler = RichHandler(
@@ -19,5 +21,5 @@ def setup_logging(terminal_width: Union[int, None] = None) -> None:
     rich_handler.setFormatter(logging.Formatter("%(message)s"))
     logger.addHandler(rich_handler)
 
-    logger.setLevel(logging.INFO)
+    logger.setLevel(level)
     logger.propagate = False