fastapi-cli 0.0.25__tar.gz → 0.0.27__tar.gz

{fastapi_cli-0.0.25 → fastapi_cli-0.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cli
-Version: 0.0.25
+Version: 0.0.27
 Summary: Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 License-Expression: MIT

{fastapi_cli-0.0.25 → fastapi_cli-0.0.27}/pyproject.toml

@@ -38,7 +38,7 @@ dependencies = [
     "rich-toolkit >= 0.14.8",
     "tomli >= 2.0.0; python_version < '3.11'",
 ]
-version = "0.0.25"
+version = "0.0.27"
 
 [project.optional-dependencies]
 standard = [

fastapi_cli-0.0.27/src/fastapi_cli/__init__.py

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

{fastapi_cli-0.0.25 → fastapi_cli-0.0.27}/src/fastapi_cli/cli.py

@@ -1,10 +1,12 @@
 import logging
+import os
 from pathlib import Path
 from typing import Annotated, Any
 
 import typer
 from pydantic import ValidationError
 from rich import print
+from rich.syntax import Syntax
 from rich.tree import Tree
 
 from fastapi_cli.config import FastAPIConfig
@@ -135,6 +137,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"
@@ -224,7 +227,25 @@ def _run(
             toolkit.print(f" • Module: {mod_source_desc}")
             toolkit.print(f" • App name: {app_source_desc}")
 
-        url = f"http://{host}:{port}"
+        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()
@@ -372,6 +393,7 @@ def dev(
         command="dev",
         proxy_headers=proxy_headers,
         forwarded_allow_ips=forwarded_allow_ips,
+        public_url=os.getenv("FASTAPI_PUBLIC_URL"),
     )
 
 
@@ -479,6 +501,7 @@ def run(
         command="run",
         proxy_headers=proxy_headers,
         forwarded_allow_ips=forwarded_allow_ips,
+        public_url=os.getenv("FASTAPI_PUBLIC_URL"),
     )
 
 

{fastapi_cli-0.0.25 → fastapi_cli-0.0.27}/tests/test_cli.py

@@ -3,6 +3,7 @@ import sys
 from pathlib import Path
 from unittest.mock import patch
 
+import pytest
 import uvicorn
 from typer.testing import CliRunner
 
@@ -38,6 +39,7 @@ def test_dev() -> None:
         assert "Configuration sources:" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting development server 🚀" in result.output
         assert "Server started at http://127.0.0.1:8000" in result.output
         assert "Documentation at http://127.0.0.1:8000/docs" in result.output
@@ -64,6 +66,9 @@ def test_dev_no_args_auto_discovery() -> None:
         assert "Using import string: main:app" in result.output
         assert "Configuration sources:" in result.output
         assert "Import string: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" in result.output
+        assert "[tool.fastapi]" in result.output
+        assert 'entrypoint = "main:app"' in result.output
 
 
 def test_dev_package() -> None:
@@ -88,6 +93,7 @@ def test_dev_package() -> None:
         assert "Using import string: nested_package.package:app" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting development server 🚀" in result.output
         assert "Server started at http://127.0.0.1:8000" in result.output
         assert "Documentation at http://127.0.0.1:8000/docs" in result.output
@@ -140,6 +146,7 @@ def test_dev_args() -> None:
         assert "Using import string: single_file_app:api" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: --app CLI option" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting development server 🚀" in result.output
         assert "Server started at http://192.168.0.2:8080" in result.output
         assert "Documentation at http://192.168.0.2:8080/docs" in result.output
@@ -173,6 +180,7 @@ def test_dev_env_vars() -> None:
         assert "Using import string: single_file_app:app" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting development server 🚀" in result.output
         assert "Server started at http://127.0.0.1:8111" in result.output
         assert "Documentation at http://127.0.0.1:8111/docs" in result.output
@@ -213,6 +221,7 @@ def test_dev_env_vars_and_args() -> None:
         assert "Using import string: single_file_app:app" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting development server 🚀" in result.output
         assert "Server started at http://127.0.0.1:8080" in result.output
         assert "Documentation at http://127.0.0.1:8080/docs" in result.output
@@ -261,6 +270,7 @@ def test_run() -> None:
         assert "Using import string: single_file_app:app" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting production server 🚀" in result.output
         assert "Server started at http://0.0.0.0:8000" in result.output
         assert "Documentation at http://0.0.0.0:8000/docs" in result.output
@@ -338,6 +348,7 @@ def test_run_args() -> None:
         assert "Using import string: single_file_app:api" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: --app CLI option" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting production server 🚀" in result.output
         assert "Server started at http://192.168.0.2:8080" in result.output
         assert "Documentation at http://192.168.0.2:8080/docs" in result.output
@@ -371,6 +382,7 @@ def test_run_env_vars() -> None:
         assert "Using import string: single_file_app:app" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting production server 🚀" in result.output
         assert "Server started at http://0.0.0.0:8111" in result.output
         assert "Documentation at http://0.0.0.0:8111/docs" in result.output
@@ -407,11 +419,60 @@ def test_run_env_vars_and_args() -> None:
         assert "Using import string: single_file_app:app" in result.output
         assert "Module: path CLI argument" in result.output
         assert "App name: auto-discovery" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
         assert "Starting production server 🚀" in result.output
         assert "Server started at http://0.0.0.0:8080" in result.output
         assert "Documentation at http://0.0.0.0:8080/docs" in result.output
 
 
+@pytest.mark.parametrize("command", ["dev", "run"])
+@pytest.mark.parametrize(
+    "public_url",
+    [
+        "https://myapp.example.com",
+        "https://myapp.example.com/",
+        "https://myapp.example.com/subpath/",
+    ],
+)
+def test_public_url_env_var(command: str, public_url: str) -> None:
+    with changing_dir(assets_path):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(
+                app,
+                [
+                    command,
+                    "single_file_app.py",
+                    "--host",
+                    "0.0.0.0",
+                ],
+                env={"FASTAPI_PUBLIC_URL": public_url},
+            )
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs == {
+                "app": "single_file_app:app",
+                "host": "0.0.0.0",
+                "port": 8000,
+                "reload": True if command == "dev" else False,
+                "reload_dirs": None,
+                "workers": None,
+                "root_path": "",
+                "proxy_headers": True,
+                "forwarded_allow_ips": None,
+                "log_config": get_uvicorn_log_config(),
+            }
+
+        assert "Using import string: single_file_app:app" in result.output
+        assert (
+            f"Starting {'development' if command == 'dev' else 'production'} server 🚀"
+            in result.output
+        )
+        expected_url_base = public_url.rstrip("/")
+        assert f"Server started at {expected_url_base}" in result.output
+        assert f"Documentation at {expected_url_base}/docs" in result.output
+
+
 def test_run_error() -> None:
     with changing_dir(assets_path):
         result = runner.invoke(app, ["run", "non_existing_file.py"])
@@ -521,6 +582,7 @@ def test_dev_with_import_string() -> None:
             }
         assert "Using import string: single_file_app:api" in result.output
         assert "Import string: --entrypoint CLI option" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
 
 
 def test_run_with_import_string() -> None:
@@ -544,6 +606,7 @@ def test_run_with_import_string() -> None:
             }
         assert "Using import string: single_file_app:app" in result.output
         assert "Import string: --entrypoint CLI option" in result.output
+        assert "You can configure an entrypoint in pyproject.toml" not in result.output
 
 
 def test_script() -> None:

fastapi_cli-0.0.25/src/fastapi_cli/__init__.py

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