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

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

@@ -1,8 +1,7 @@
 Metadata-Version: 2.1
 Name: fastapi-cli
-Version: 0.0.4
+Version: 0.0.6
 Summary: Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
-Home-page: https://github.com/tiangolo/fastapi-cli
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 License: MIT
 Classifier: Intended Audience :: Information Technology
@@ -20,40 +19,42 @@ Classifier: Framework :: FastAPI
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 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/tiangolo/fastapi-cli
-Project-URL: Repository, https://github.com/tiangolo/fastapi-cli
+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: fastapi; extra == "standard"
-Requires-Dist: uvicorn[standard]>=0.15.0; extra == "standard"
+Requires-Dist: uvicorn[standard]>=0.15.0
+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
 
-<a href="https://github.com/tiangolo/fastapi-cli/actions/workflows/test.yml" target="_blank">
-    <img src="https://github.com/tiangolo/fastapi-cli/actions/workflows/test.yml/badge.svg" alt="Test">
+<a href="https://github.com/fastapi/fastapi-cli/actions/workflows/test.yml" target="_blank">
+    <img src="https://github.com/fastapi/fastapi-cli/actions/workflows/test.yml/badge.svg" alt="Test">
 </a>
-<a href="https://github.com/tiangolo/fastapi-cli/actions/workflows/publish.yml" target="_blank">
-    <img src="https://github.com/tiangolo/fastapi-cli/actions/workflows/publish.yml/badge.svg" alt="Publish">
+<a href="https://github.com/fastapi/fastapi-cli/actions/workflows/publish.yml" target="_blank">
+    <img src="https://github.com/fastapi/fastapi-cli/actions/workflows/publish.yml/badge.svg" alt="Publish">
 </a>
-<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/fastapi-cli" target="_blank">
-    <img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/fastapi-cli.svg" alt="Coverage">
+<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi-cli" target="_blank">
+    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi-cli.svg" alt="Coverage">
 <a href="https://pypi.org/project/fastapi-cli" target="_blank">
     <img src="https://img.shields.io/pypi/v/fastapi-cli?color=%2334D058&label=pypi%20package" alt="Package version">
 </a>
 
 ---
 
-**Source Code**: <a href="https://github.com/tiangolo/fastapi-cli" target="_blank">https://github.com/tiangolo/fastapi-cli</a>
+**Source Code**: <a href="https://github.com/fastapi/fastapi-cli" target="_blank">https://github.com/fastapi/fastapi-cli</a>
 
 ---
 
@@ -63,7 +64,7 @@ Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
 
 **FastAPI CLI** is a command line program `fastapi` that you can use to serve your FastAPI app, manage your FastAPI project, and more.
 
-When you install FastAPI (e.g. with `pip install fastapi`), it includes a package called `fastapi-cli`, this package provides the `fastapi` command in the terminal.
+When you install FastAPI (e.g. with `pip install "fastapi[standard]"`), it includes a package called `fastapi-cli`, this package provides the `fastapi` command in the terminal.
 
 To run your FastAPI app for development, you can use the `fastapi dev` command:
 
@@ -71,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.6/README.md

@@ -0,0 +1,94 @@
+# FastAPI CLI
+
+<a href="https://github.com/fastapi/fastapi-cli/actions/workflows/test.yml" target="_blank">
+    <img src="https://github.com/fastapi/fastapi-cli/actions/workflows/test.yml/badge.svg" alt="Test">
+</a>
+<a href="https://github.com/fastapi/fastapi-cli/actions/workflows/publish.yml" target="_blank">
+    <img src="https://github.com/fastapi/fastapi-cli/actions/workflows/publish.yml/badge.svg" alt="Publish">
+</a>
+<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi-cli" target="_blank">
+    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi-cli.svg" alt="Coverage">
+<a href="https://pypi.org/project/fastapi-cli" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-cli?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+
+---
+
+**Source Code**: <a href="https://github.com/fastapi/fastapi-cli" target="_blank">https://github.com/fastapi/fastapi-cli</a>
+
+---
+
+Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
+
+## Description
+
+**FastAPI CLI** is a command line program `fastapi` that you can use to serve your FastAPI app, manage your FastAPI project, and more.
+
+When you install FastAPI (e.g. with `pip install "fastapi[standard]"`), it includes a package called `fastapi-cli`, this package provides the `fastapi` command in the terminal.
+
+To run your FastAPI app for development, you can use the `fastapi dev` command:
+
+<div class="termy">
+
+```console
+$ fastapi dev main.py
+
+   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>
+
+That command line program called `fastapi` is **FastAPI CLI**.
+
+FastAPI CLI takes the path to your Python program and automatically detects the variable with the FastAPI (commonly named `app`) and how to import it, and then serves it.
+
+For production you would use `fastapi run` instead. 🚀
+
+Internally, **FastAPI CLI** uses <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>, a high-performance, production-ready, ASGI server. 😎
+
+## `fastapi dev`
+
+When you run `fastapi dev`, it will run on development mode.
+
+By default, it will have **auto-reload** enabled, so it will automatically reload the server when you make changes to your code. This is resource intensive and could be less stable than without it, you should only use it for development.
+
+By default it will listen on the IP address `127.0.0.1`, which is the IP for your machine to communicate with itself alone (`localhost`).
+
+## `fastapi run`
+
+When you run `fastapi run`, it will run on production mode by default.
+
+It will have **auto-reload disabled** by default.
+
+It will listen on the IP address `0.0.0.0`, which means all the available IP addresses, this way it will be publicly accessible to anyone that can communicate with the machine. This is how you would normally run it in production, for example, in a container.
+
+In most cases you would (and should) have a "termination proxy" handling HTTPS for you on top, this will depend on how you deploy your application, your provider might do this for you, or you might need to set it up yourself. You can learn more about it in the <a href="https://fastapi.tiangolo.com/deployment/" class="external-link" target="_blank">FastAPI Deployment documentation</a>.
+
+## License
+
+This project is licensed under the terms of the MIT license.

fastapi_cli-0.0.6/pdm_build.py

@@ -0,0 +1,20 @@
+import os
+from typing import Any, Dict
+
+from pdm.backend.hooks import Context
+
+TIANGOLO_BUILD_PACKAGE = os.getenv("TIANGOLO_BUILD_PACKAGE", "fastapi-cli")
+
+
+def pdm_build_initialize(context: Context):
+    metadata = context.config.metadata
+    # Get custom config for the current package, from the env var
+    config: Dict[str, Any] = context.config.data["tool"]["tiangolo"][
+        "_internal-slim-build"
+    ]["packages"].get(TIANGOLO_BUILD_PACKAGE)
+    if not config:
+        return
+    project_config: Dict[str, Any] = config["project"]
+    # Override main [project] configs with custom configs for this package
+    for key, value in project_config.items():
+        metadata[key] = value

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

@@ -23,7 +23,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -33,22 +32,25 @@ classifiers = [
 ]
 dependencies = [
     "typer >= 0.12.3",
+    "uvicorn[standard] >= 0.15.0",
+    "rich-toolkit >= 0.11.1",
 ]
-version = "0.0.4"
+version = "0.0.6"
 
 [project.license]
 text = "MIT"
 
 [project.optional-dependencies]
 standard = [
-    "fastapi",
     "uvicorn[standard] >= 0.15.0",
 ]
 
 [project.urls]
-Documentation = "https://fastapi.tiangolo.com"
-homepage = "https://github.com/tiangolo/fastapi-cli"
-Repository = "https://github.com/tiangolo/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"
@@ -76,11 +78,6 @@ source-includes = [
 [tool.tiangolo._internal-slim-build.packages.fastapi-cli-slim.project]
 name = "fastapi-cli-slim"
 
-[tool.tiangolo._internal-slim-build.packages.fastapi-cli]
-include-optional-dependencies = []
-
-[tool.tiangolo._internal-slim-build.packages.fastapi-cli.project]
-
 [tool.pytest.ini_options]
 addopts = [
     "--strict-config",
@@ -97,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",
@@ -109,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.4 → fastapi_cli-0.0.6}/requirements-tests.txt

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

{fastapi_cli-0.0.4 → 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.4 → 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.4 → 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.4 → 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()