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

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: fastapi-cli
-Version: 0.0.3
+Version: 0.0.5
 Summary: Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀
-Home-page: https://github.com/tiangolo/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
@@ -20,7 +20,6 @@ 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
@@ -28,31 +27,32 @@ 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: Repository, https://github.com/fastapi/fastapi-cli
 Requires-Python: >=3.8
 Requires-Dist: typer>=0.12.3
-Requires-Dist: fastapi
 Requires-Dist: uvicorn[standard]>=0.15.0
+Requires-Dist: uvicorn[standard]>=0.15.0; extra == "standard"
+Provides-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>
 
 ---
 
@@ -62,7 +62,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:
 

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

@@ -1,20 +1,20 @@
 # 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>
 
 ---
 
@@ -24,7 +24,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:
 

fastapi_cli-0.0.5/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.3 → fastapi_cli-0.0.5}/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,20 +32,22 @@ classifiers = [
 ]
 dependencies = [
     "typer >= 0.12.3",
-    "fastapi",
     "uvicorn[standard] >= 0.15.0",
 ]
-version = "0.0.3"
+version = "0.0.5"
 
 [project.license]
 text = "MIT"
 
 [project.optional-dependencies]
+standard = [
+    "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"
+Repository = "https://github.com/fastapi/fastapi-cli"
 
 [project.scripts]
 fastapi = "fastapi_cli.cli:main"
@@ -74,13 +75,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 = [
-    "standard",
-]
-
-[tool.tiangolo._internal-slim-build.packages.fastapi-cli.project.optional-dependencies]
-
 [tool.pytest.ini_options]
 addopts = [
     "--strict-config",

{fastapi_cli-0.0.3 → fastapi_cli-0.0.5}/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.11.1
+ruff ==0.5.5
 # Needed explicitly by fastapi-cli-slim
 fastapi-slim
 uvicorn

fastapi_cli-0.0.5/src/fastapi_cli/__init__.py

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

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

@@ -3,7 +3,6 @@ from pathlib import Path
 from typing import Any, Union
 
 import typer
-import uvicorn
 from rich import print
 from rich.padding import Padding
 from rich.panel import Panel
@@ -20,6 +19,11 @@ app = typer.Typer(rich_markup_mode="rich")
 setup_logging()
 logger = getLogger(__name__)
 
+try:
+    import uvicorn
+except ImportError:  # pragma: no cover
+    uvicorn = None  # type: ignore[assignment]
+
 
 def version_callback(value: bool) -> None:
     if value:
@@ -81,6 +85,10 @@ def _run(
             style="green",
         )
     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,

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

@@ -5,7 +5,6 @@ from logging import getLogger
 from pathlib import Path
 from typing import Union
 
-from fastapi import FastAPI
 from rich import print
 from rich.padding import Padding
 from rich.panel import Panel
@@ -16,26 +15,27 @@ from fastapi_cli.exceptions import FastAPICLIException
 
 logger = getLogger(__name__)
 
+try:
+    from fastapi import FastAPI
+except ImportError:  # pragma: no cover
+    FastAPI = None  # type: ignore[misc, assignment]
+
 
 def get_default_path() -> Path:
-    path = Path("main.py")
-    if path.is_file():
-        return path
-    path = Path("app.py")
-    if path.is_file():
-        return path
-    path = Path("api.py")
-    if path.is_file():
-        return path
-    path = Path("app/main.py")
-    if path.is_file():
-        return path
-    path = Path("app/app.py")
-    if path.is_file():
-        return path
-    path = Path("app/api.py")
-    if path.is_file():
-        return path
+    potential_paths = (
+        "main.py",
+        "app.py",
+        "api.py",
+        "app/main.py",
+        "app/app.py",
+        "app/api.py",
+    )
+
+    for full_path in potential_paths:
+        path = Path(full_path)
+        if path.is_file():
+            return path
+
     raise FastAPICLIException(
         "Could not find a default file to run, please provide an explicit path"
     )
@@ -107,6 +107,10 @@ def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) ->
             "Ensure all the package directories have an [blue]__init__.py[/blue] file"
         )
         raise
+    if not FastAPI:  # type: ignore[truthy-function]
+        raise FastAPICLIException(
+            "Could not import FastAPI, try running 'pip install fastapi'"
+        ) from None
     object_names = dir(mod)
     object_names_set = set(object_names)
     if app_name:

fastapi_cli-0.0.5/tests/test_requirements.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+
+import pytest
+from fastapi_cli.discover import get_import_string
+from fastapi_cli.exceptions import FastAPICLIException
+from typer.testing import CliRunner
+
+from .utils import changing_dir
+
+runner = CliRunner()
+
+assets_path = Path(__file__).parent / "assets"
+
+
+def test_no_uvicorn() -> None:
+    import fastapi_cli.cli
+    import uvicorn
+
+    fastapi_cli.cli.uvicorn = None  # type: ignore[attr-defined, assignment]
+
+    with changing_dir(assets_path):
+        result = runner.invoke(fastapi_cli.cli.app, ["dev", "single_file_app.py"])
+        assert result.exit_code == 1
+        assert result.exception is not None
+        assert (
+            "Could not import Uvicorn, try running 'pip install uvicorn'"
+            in result.exception.args[0]
+        )
+
+    fastapi_cli.cli.uvicorn = uvicorn  # type: ignore[attr-defined]
+
+
+def test_no_fastapi() -> None:
+    import fastapi_cli.discover
+    from fastapi import FastAPI
+
+    fastapi_cli.discover.FastAPI = None  # type: ignore[attr-defined, assignment]
+    with changing_dir(assets_path):
+        with pytest.raises(FastAPICLIException) as exc_info:
+            get_import_string(path=Path("single_file_app.py"))
+        assert "Could not import FastAPI, try running 'pip install fastapi'" in str(
+            exc_info.value
+        )
+
+    fastapi_cli.discover.FastAPI = FastAPI  # type: ignore[attr-defined]

fastapi_cli-0.0.3/pdm_build.py

@@ -1,39 +0,0 @@
-import os
-from typing import Any, Dict, List
-
-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"][TIANGOLO_BUILD_PACKAGE]
-    project_config: Dict[str, Any] = config["project"]
-    # Get main optional dependencies, extras
-    optional_dependencies: Dict[str, List[str]] = metadata.get(
-        "optional-dependencies", {}
-    )
-    # Get custom optional dependencies name to always include in this (non-slim) package
-    include_optional_dependencies: List[str] = config.get(
-        "include-optional-dependencies", []
-    )
-    # Override main [project] configs with custom configs for this package
-    for key, value in project_config.items():
-        metadata[key] = value
-    # Get custom build config for the current package
-    build_config: Dict[str, Any] = (
-        config.get("tool", {}).get("pdm", {}).get("build", {})
-    )
-    # Override PDM build config with custom build config for this package
-    for key, value in build_config.items():
-        context.config.build_config[key] = value
-    # Get main dependencies
-    dependencies: List[str] = metadata.get("dependencies", [])
-    # Add optional dependencies to the default dependencies for this (non-slim) package
-    for include_optional in include_optional_dependencies:
-        optional_dependencies_group = optional_dependencies.get(include_optional, [])
-        dependencies.extend(optional_dependencies_group)

fastapi_cli-0.0.3/src/fastapi_cli/__init__.py

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