Merge branch 'main' into feat/plugin-entry-points

Author: craforge

.pre-commit-config.yaml

@@ -11,6 +11,11 @@ repos:
         -   --unsafe
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+-   repo: https://github.com/crate-ci/typos
+    rev: bbaefadf97b0ec5fdc942684b647f1a6ab250274 # v1.46.0
+    hooks:
+    -   id: typos
+        args: [--force-exclude]
 -   repo: local
     hooks:
       - id: local-ruff-check

pyproject.toml

@@ -161,3 +161,15 @@ keep-runtime-typing = true
 
 [tool.ty.terminal]
 error-on-warning = true
+
+[tool.typos.files]
+extend-exclude = [
+    "coverage/",
+    "dist/",
+    "release-notes.md",
+    "htmlcov/",
+    "uv.lock",
+]
+
+[tool.typos.default.extend-identifiers]
+alls = "alls"

release-notes.md

@@ -2,13 +2,33 @@
 
 ## Latest Changes
 
+## 0.0.27 (2026-06-18)
+
+### Features
+
+* ✨ Add `FASTAPI_PUBLIC_URL` env var to configure app's public URL that is shown on startup. PR [#381](https://github.com/fastapi/fastapi-cli/pull/381) by [@YuriiMotov](https://github.com/YuriiMotov).
+
+## 0.0.26 (2026-06-18)
+
+### Features
+
+* 🚸 Show tip on how to configure `entrypoint` in `pyproject.toml`. PR [#389](https://github.com/fastapi/fastapi-cli/pull/389) by [@YuriiMotov](https://github.com/YuriiMotov).
+
+## 0.0.25 (2026-06-18)
+
+### Features
+
+* 🚸 Show import string source. PR [#388](https://github.com/fastapi/fastapi-cli/pull/388) by [@YuriiMotov](https://github.com/YuriiMotov).
+* ✨ Include the version of `fastapi-cloud-cli` to the output of `--version`. PR [#341](https://github.com/fastapi/fastapi-cli/pull/341) by [@YuriiMotov](https://github.com/YuriiMotov).
+
 ### Docs
 
 * 📝 Update docs about contributing. PR [#410](https://github.com/fastapi/fastapi-cli/pull/410) by [@tiangolo](https://github.com/tiangolo).
 * 📝 Update security policy. PR [#408](https://github.com/fastapi/fastapi-cli/pull/408) by [@tiangolo](https://github.com/tiangolo).
 
 ### Internal
 
+* 👷 Add pre-commit hook to catch typos. PR [#418](https://github.com/fastapi/fastapi-cli/pull/418) by [@YuriiMotov](https://github.com/YuriiMotov).
 * ⬆ Bump typer from 0.26.2 to 0.26.7. PR [#427](https://github.com/fastapi/fastapi-cli/pull/427) by [@dependabot[bot]](https://github.com/apps/dependabot).
 * ⬆ Bump fastapi-cloud-cli from 0.17.1 to 0.19.0. PR [#429](https://github.com/fastapi/fastapi-cli/pull/429) by [@dependabot[bot]](https://github.com/apps/dependabot).
 * ⬆ Bump rich-toolkit from 0.19.9 to 0.20.0. PR [#428](https://github.com/fastapi/fastapi-cli/pull/428) by [@dependabot[bot]](https://github.com/apps/dependabot).

src/fastapi_cli/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.24"
+__version__ = "0.0.27"

src/fastapi_cli/cli.py

@@ -6,11 +6,17 @@
 import typer
 from pydantic import ValidationError
 from rich import print
+from rich.syntax import Syntax
 from rich.tree import Tree
 from typer.models import CommandInfo
 
 from fastapi_cli.config import FastAPIConfig
-from fastapi_cli.discover import get_import_data, get_import_data_from_import_string
+from fastapi_cli.discover import (
+    AppConfigSource,
+    ModuleConfigSource,
+    get_import_data,
+    get_import_data_from_import_string,
+)
 from fastapi_cli.exceptions import FastAPICLIException
 
 from . import __version__
@@ -22,6 +28,15 @@
 logger = logging.getLogger(__name__)
 
 
+SOURCE_DESCRIPTIONS: dict[ModuleConfigSource | AppConfigSource, str] = {
+    "entrypoint-option": "[blue]--entrypoint[/] CLI option",
+    "entrypoint-pyproject": "[blue]entrypoint[/] in [blue]pyproject.toml[/]",
+    "path-argument": "[blue]path[/] CLI argument",
+    "app-option": "[blue]--app[/] CLI option",
+    "auto-discovery": "auto-discovery",
+}
+
+
 try:
     import uvicorn
 except ImportError:  # pragma: no cover
@@ -101,6 +116,15 @@ def _load_cli_plugins(typer_app: typer.Typer) -> None:
 def version_callback(value: bool) -> None:
     if value:
         print(f"FastAPI CLI version: [green]{__version__}[/green]")
+        try:
+            from fastapi_cloud_cli import (
+                __version__ as cloud_cli_version,
+            )
+
+            print(f"FastAPI Cloud CLI version: [green]{cloud_cli_version}[/green]")
+        except ImportError:  # pragma: no cover
+            pass
+
         raise typer.Exit()
 
 
@@ -158,6 +182,7 @@ def _run(
     entrypoint: str | None = None,
     proxy_headers: bool = False,
     forwarded_allow_ips: str | None = None,
+    public_url: str | None = None,
 ) -> None:
     with get_rich_toolkit() as toolkit:
         server_type = "development" if command == "dev" else "production"
@@ -195,7 +220,9 @@ def _run(
             if path or app:
                 import_data = get_import_data(path=path, app_name=app)
             elif config.entrypoint:
-                import_data = get_import_data_from_import_string(config.entrypoint)
+                import_data = get_import_data_from_import_string(
+                    config.entrypoint, config.from_pyproject
+                )
             else:
                 import_data = get_import_data()
         except FastAPICLIException as e:
@@ -233,7 +260,35 @@ def _run(
             tag="app",
         )
 
-        url = f"http://{host}:{port}"
+        mod_source_desc = SOURCE_DESCRIPTIONS[import_data.module_config_source]
+        app_source_desc = SOURCE_DESCRIPTIONS[import_data.app_name_config_source]
+        toolkit.print_line()
+        toolkit.print("Configuration sources:", tag="info")
+        if mod_source_desc == app_source_desc:
+            toolkit.print(f" • Import string: {mod_source_desc}")
+        else:
+            toolkit.print(f" • Module: {mod_source_desc}")
+            toolkit.print(f" • App name: {app_source_desc}")
+
+        if import_data.module_config_source == "auto-discovery":
+            toolkit.print_line()
+            toolkit.print(
+                "You can configure an entrypoint in [blue]pyproject.toml[/] for this app with:",
+                tag="tip",
+            )
+            toolkit.print_line()
+            toolkit.print(
+                Syntax(
+                    (
+                        "[tool.fastapi]\n"
+                        f'entrypoint = "{import_data.module_data.module_import_str}:{import_data.app_name}"'
+                    ),
+                    "toml",
+                    theme="ansi_light",
+                )
+            )
+
+        url = public_url.rstrip("/") if public_url else f"http://{host}:{port}"
         url_docs = f"{url}/docs"
 
         toolkit.print_line()
@@ -379,6 +434,7 @@ def dev(
         command="dev",
         proxy_headers=proxy_headers,
         forwarded_allow_ips=forwarded_allow_ips,
+        public_url=os.getenv("FASTAPI_PUBLIC_URL"),
     )
 
 
@@ -486,6 +542,7 @@ def run(
         command="run",
         proxy_headers=proxy_headers,
         forwarded_allow_ips=forwarded_allow_ips,
+        public_url=os.getenv("FASTAPI_PUBLIC_URL"),
     )
 
 

src/fastapi_cli/config.py

@@ -9,6 +9,7 @@
 
 class FastAPIConfig(BaseModel):
     entrypoint: StrictStr | None = None
+    from_pyproject: bool = False
 
     @classmethod
     def _read_pyproject_toml(cls) -> dict[str, Any]:
@@ -39,4 +40,6 @@ def resolve(cls, entrypoint: str | None = None) -> "FastAPIConfig":
         if entrypoint is not None:
             config["entrypoint"] = entrypoint
 
+        config["from_pyproject"] = ("entrypoint" in config) and (entrypoint is None)
+
         return cls.model_validate(config)

src/fastapi_cli/discover.py

@@ -3,6 +3,7 @@
 from dataclasses import dataclass
 from logging import getLogger
 from pathlib import Path
+from typing import Literal, TypeAlias
 
 from fastapi_cli.exceptions import FastAPICLIException
 
@@ -102,18 +103,35 @@ def get_app_name(*, mod_data: ModuleData, app_name: str | None = None) -> str:
     raise FastAPICLIException("Could not find FastAPI app in module, try using --app")
 
 
+ModuleConfigSource: TypeAlias = Literal[
+    "entrypoint-option",
+    "entrypoint-pyproject",
+    "path-argument",
+    "auto-discovery",
+]
+
+AppConfigSource: TypeAlias = Literal[
+    "entrypoint-option", "entrypoint-pyproject", "app-option", "auto-discovery"
+]
+
+
 @dataclass
 class ImportData:
     app_name: str
     module_data: ModuleData
     import_string: str
 
+    module_config_source: ModuleConfigSource
+    app_name_config_source: AppConfigSource
+
 
 def get_import_data(
     *, path: Path | None = None, app_name: str | None = None
 ) -> ImportData:
+    path_config_source: ModuleConfigSource = "path-argument"
     if not path:
         path = get_default_path()
+        path_config_source = "auto-discovery"
 
     logger.debug(f"Using path [blue]{path}[/blue]")
     logger.debug(f"Resolved absolute path {path.resolve()}")
@@ -127,11 +145,17 @@ def get_import_data(
     import_string = f"{mod_data.module_import_str}:{use_app_name}"
 
     return ImportData(
-        app_name=use_app_name, module_data=mod_data, import_string=import_string
+        app_name=use_app_name,
+        module_data=mod_data,
+        import_string=import_string,
+        module_config_source=path_config_source,
+        app_name_config_source="app-option" if app_name else "auto-discovery",
     )
 
 
-def get_import_data_from_import_string(import_string: str) -> ImportData:
+def get_import_data_from_import_string(
+    import_string: str, from_pyproject: bool
+) -> ImportData:
     module_str, _, app_name = import_string.partition(":")
 
     if not module_str or not app_name:
@@ -151,4 +175,10 @@ def get_import_data_from_import_string(import_string: str) -> ImportData:
             module_paths=[],
         ),
         import_string=import_string,
+        module_config_source=(
+            "entrypoint-pyproject" if from_pyproject else "entrypoint-option"
+        ),
+        app_name_config_source=(
+            "entrypoint-pyproject" if from_pyproject else "entrypoint-option"
+        ),
     )