fastapi-cloud-cli 0.20.0__tar.gz → 0.22.0__tar.gz

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-cloud-cli
-Version: 0.20.0
+Version: 0.22.0
 Summary: Deploy and manage FastAPI Cloud apps from the command line 🚀
 Author-Email: Patrick Arminio <patrick@fastapilabs.com>
 License: MIT
@@ -49,9 +49,6 @@ Description-Content-Type: text/markdown
 <a href="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/test.yml" target="_blank">
     <img src="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/test.yml/badge.svg" alt="Test">
 </a>
-<a href="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/publish.yml" target="_blank">
-    <img src="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/publish.yml/badge.svg" alt="Publish">
-</a>
 <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapilabs/fastapi-cloud-cli" target="_blank">
     <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapilabs/fastapi-cloud-cli.svg" alt="Coverage">
 <a href="https://pypi.org/project/fastapi-cloud-cli" target="_blank">

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/README.md

@@ -3,9 +3,6 @@
 <a href="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/test.yml" target="_blank">
     <img src="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/test.yml/badge.svg" alt="Test">
 </a>
-<a href="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/publish.yml" target="_blank">
-    <img src="https://github.com/fastapilabs/fastapi-cloud-cli/actions/workflows/publish.yml/badge.svg" alt="Publish">
-</a>
 <a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapilabs/fastapi-cloud-cli" target="_blank">
     <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapilabs/fastapi-cloud-cli.svg" alt="Coverage">
 <a href="https://pypi.org/project/fastapi-cloud-cli" target="_blank">

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "fastar >= 0.10.0",
     "detect-installer>=0.1.0",
 ]
-version = "0.20.0"
+version = "0.22.0"
 
 [project.license]
 text = "MIT"
@@ -64,9 +64,9 @@ dev = [
     "pytest>=7.0.0,<10.0.0",
     "coverage[toml]>=7.2,<8.0",
     "mypy==2.1.0",
-    "ruff==0.15.15",
+    "ruff>=0.15.16",
     "respx==0.23.1",
-    "time-machine==2.19.0",
+    "time-machine>=2.19.0",
     "ty>=0.0.25",
     "zizmor>=1.24.1",
 ]
@@ -170,11 +170,15 @@ keep-runtime-typing = true
 
 [tool.typos.files]
 extend-exclude = [
-    "release-notes.md",
     "uv.lock",
     "coverage/",
     "htmlcov/",
 ]
 
+[tool.typos.default]
+extend-ignore-re = [
+    "@[a-zA-Z0-9](?:-?[a-zA-Z0-9])*",
+]
+
 [tool.typos.default.extend-identifiers]
 alls = "alls"

fastapi_cloud_cli-0.22.0/src/fastapi_cloud_cli/__init__.py

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

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/cli.py

@@ -8,6 +8,7 @@ from .commands.apps import apps_app
 from .commands.apps.link import link_app
 from .commands.apps.unlink import unlink_app
 from .commands.auth import auth_app
+from .commands.ci import ci_app
 from .commands.deploy import deploy
 from .commands.deployments import deployments_app
 from .commands.env import env_app
@@ -16,6 +17,7 @@ from .commands.logout import logout
 from .commands.logs import logs
 from .commands.setup_ci import setup_ci
 from .commands.teams import teams_app
+from .commands.tokens import tokens_app
 from .commands.whoami import whoami
 from .logging import setup_logging
 from .utils.sentry import init_sentry
@@ -69,8 +71,10 @@ cloud_app.command()(setup_ci)
 cloud_app.add_typer(env_app, name="env")
 cloud_app.add_typer(auth_app, name="auth")
 cloud_app.add_typer(apps_app, name="apps")
+cloud_app.add_typer(ci_app, name="ci")
 cloud_app.add_typer(deployments_app, name="deployments")
 cloud_app.add_typer(teams_app, name="teams")
+cloud_app.add_typer(tokens_app, name="tokens")
 
 # fastapi [command]
 app.command()(deploy)

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/apps/__init__.py

@@ -5,6 +5,7 @@ from fastapi_cloud_cli.commands.apps.get import get_app
 from fastapi_cloud_cli.commands.apps.link import link_app
 from fastapi_cloud_cli.commands.apps.list import list_apps
 from fastapi_cloud_cli.commands.apps.unlink import unlink_app
+from fastapi_cloud_cli.commands.apps.update import update_app
 from fastapi_cloud_cli.commands.logs import logs
 
 apps_app = typer.Typer(
@@ -17,5 +18,6 @@ apps_app.command("link")(link_app)
 apps_app.command("list")(list_apps)
 apps_app.command("logs")(logs)
 apps_app.command("unlink")(unlink_app)
+apps_app.command("update")(update_app)
 
 __all__ = ["apps_app"]

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/apps/create.py

@@ -75,7 +75,10 @@ def create_app(
         str | None,
         typer.Option(
             "--directory",
-            help="Directory containing the app's pyproject.toml.",
+            help=(
+                "Relative app directory containing the pyproject.toml "
+                "(for example: backend or webserver)."
+            ),
         ),
     ] = None,
     link: Annotated[
@@ -146,7 +149,17 @@ def create_app(
                 )
                 toolkit.print_line()
 
-            directory = validate_app_directory(directory)
+            try:
+                directory = validate_app_directory(directory)
+            except ValueError as e:
+                toolkit.fail(
+                    "invalid_input",
+                    f"Invalid app directory: {e}",
+                    hint=(
+                        "Pass a relative app directory such as `backend` or `webserver`; "
+                        "use --path with --link to choose a local filesystem path."
+                    ),
+                )
 
             with toolkit.progress(
                 title="Creating app",

fastapi_cloud_cli-0.22.0/src/fastapi_cloud_cli/commands/apps/update.py

@@ -0,0 +1,122 @@
+import logging
+from typing import Annotated, Any
+
+import typer
+from pydantic import BaseModel
+from rich_toolkit import RichToolkit
+
+from fastapi_cloud_cli.commands.deploy.archive import validate_app_directory
+from fastapi_cloud_cli.utils.api import APIClient
+from fastapi_cloud_cli.utils.apps import resolve_app_id_or_fail
+from fastapi_cloud_cli.utils.auth import Identity
+from fastapi_cloud_cli.utils.cli import get_rich_toolkit
+from fastapi_cloud_cli.utils.execution import JsonOutputOption
+
+logger = logging.getLogger(__name__)
+
+
+class UpdatedApp(BaseModel):
+    id: str
+    team_id: str
+    slug: str
+    name: str
+    directory: str | None
+
+
+class AppsUpdateOutput(BaseModel):
+    app: UpdatedApp
+
+
+def _update_app(client: APIClient, *, app_id: str, directory: str | None) -> UpdatedApp:
+    response = client.patch(
+        f"/apps/{app_id}",
+        json={"directory": directory},
+    )
+    response.raise_for_status()
+
+    return UpdatedApp.model_validate(response.json())
+
+
+def _render_apps_update_output(data: AppsUpdateOutput, toolkit: RichToolkit) -> None:
+    toolkit.print(f"Updated app [bold]{data.app.name}[/bold]", bullet=False)
+    toolkit.print(
+        f"Directory: [bold]{data.app.directory if data.app.directory is not None else '.'}[/bold]",
+        bullet=False,
+    )
+
+
+def update_app(
+    app_id: Annotated[
+        str | None,
+        typer.Argument(
+            help="ID of the app to update (defaults to the app linked to the current directory).",
+        ),
+    ] = None,
+    directory: Annotated[
+        str | None,
+        typer.Option(
+            "--directory",
+            help=(
+                "Relative app directory containing the pyproject.toml "
+                "(for example: src or backend)."
+            ),
+        ),
+    ] = None,
+    json_output: JsonOutputOption = False,
+) -> Any:
+    """
+    Update FastAPI Cloud app metadata.
+    """
+    identity = Identity()
+
+    with get_rich_toolkit(json_output=json_output) as toolkit:
+        if not identity.is_logged_in():
+            toolkit.fail(
+                "not_logged_in",
+                "No credentials found.",
+                hint="Run `fastapi cloud login` or set FASTAPI_CLOUD_TOKEN.",
+            )
+
+        if directory is None:
+            toolkit.fail(
+                "missing_required_input",
+                "No updates provided.",
+                hint="Pass --directory to update the app directory.",
+            )
+
+        target_app_id = resolve_app_id_or_fail(
+            toolkit,
+            app_id=app_id,
+            hint="Pass an app ID or run `fastapi cloud apps create --link` first.",
+        )
+
+        try:
+            directory = validate_app_directory(directory)
+        except ValueError as e:
+            toolkit.fail(
+                "invalid_input",
+                f"Invalid app directory: {e}",
+                hint="Pass a relative app directory such as `src` or `backend`.",
+            )
+
+        with APIClient() as client:
+            with toolkit.progress(
+                title="Updating app",
+                transient=True,
+            ) as progress:
+                with client.handle_http_errors(
+                    progress,
+                    default_message="Error updating app. Please try again later.",
+                    not_found_message="App not found.",
+                    toolkit=toolkit,
+                ):
+                    app = _update_app(
+                        client,
+                        app_id=target_app_id,
+                        directory=directory,
+                    )
+
+        toolkit.success(
+            AppsUpdateOutput(app=app),
+            render_output=_render_apps_update_output,
+        )

fastapi_cloud_cli-0.22.0/src/fastapi_cloud_cli/commands/ci/__init__.py

@@ -0,0 +1,15 @@
+import typer
+
+from fastapi_cloud_cli.commands.ci.print_workflow import (
+    print_workflow as print_workflow_command,
+)
+from fastapi_cloud_cli.commands.setup_ci import setup_ci
+
+ci_app = typer.Typer(
+    no_args_is_help=True,
+    help="Manage CI integration helpers.",
+)
+ci_app.command("print-workflow")(print_workflow_command)
+ci_app.command("setup")(setup_ci)
+
+__all__ = ["ci_app"]

fastapi_cloud_cli-0.22.0/src/fastapi_cloud_cli/commands/ci/print_workflow.py

@@ -0,0 +1,45 @@
+from typing import Annotated, Any
+
+import typer
+from pydantic import BaseModel
+from rich_toolkit import RichToolkit
+
+from fastapi_cloud_cli.commands.setup_ci import (
+    DEFAULT_WORKFLOW_PATH,
+    _get_default_branch,
+    _get_workflow_content,
+)
+from fastapi_cloud_cli.utils.cli import get_rich_toolkit
+from fastapi_cloud_cli.utils.execution import JsonOutputOption
+
+
+class CIWorkflowOutput(BaseModel):
+    filename: str
+    content: str
+
+
+def _render_workflow_output(data: CIWorkflowOutput, toolkit: RichToolkit) -> None:
+    toolkit.console.print(data.content, markup=False, end="")
+
+
+def print_workflow(
+    branch: Annotated[
+        str | None,
+        typer.Option(
+            "--branch",
+            "-b",
+            help="Branch that triggers deploys (defaults to the repo's default branch).",
+        ),
+    ] = None,
+    json_output: JsonOutputOption = False,
+) -> Any:
+    """Prints the GitHub Actions workflow YAML without writing files or secrets."""
+
+    branch = branch or _get_default_branch()
+    workflow = CIWorkflowOutput(
+        filename=DEFAULT_WORKFLOW_PATH.name,
+        content=_get_workflow_content(branch),
+    )
+
+    with get_rich_toolkit(minimal=True, json_output=json_output) as toolkit:
+        toolkit.success(workflow, render_output=_render_workflow_output)

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/deploy/command.py

@@ -331,7 +331,7 @@ def deploy(
                             f"Deployment created successfully! Deployment slug: {deployment.slug}"
                         )
 
-                        _upload_deployment(
+                        deployment = _upload_deployment(
                             fastapi_client=client,
                             deployment_id=deployment.id,
                             archive_path=archive_path,

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/deploy/upload.py

@@ -6,6 +6,7 @@ from httpx import Client
 from pydantic import BaseModel
 from rich_toolkit.progress import Progress
 
+from fastapi_cloud_cli.commands.deploy.cloud import CreateDeploymentResponse
 from fastapi_cloud_cli.utils.api import APIClient
 from fastapi_cloud_cli.utils.progress_file import ProgressFile
 
@@ -43,7 +44,7 @@ def _upload_deployment(
     deployment_id: str,
     archive_path: Path,
     progress: Progress,
-) -> None:
+) -> CreateDeploymentResponse:
     archive_size = archive_path.stat().st_size
     archive_size_str = _format_size(archive_size)
 
@@ -88,3 +89,5 @@ def _upload_deployment(
 
     notify_response.raise_for_status()
     logger.debug("Upload notification sent successfully")
+
+    return CreateDeploymentResponse.model_validate(notify_response.json())

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/deploy/wait.py

@@ -46,7 +46,6 @@ LONG_WAIT_MESSAGES = [
 def _verify_deployment(
     toolkit: RichToolkit,
     client: APIClient,
-    app_id: str,
     deployment: CreateDeploymentResponse,
 ) -> None:
     failed_status: str | None = None
@@ -57,7 +56,7 @@ def _verify_deployment(
         done_emoji="✅",
     ) as progress:
         try:
-            final_status = client.poll_deployment_status(app_id, deployment.id)
+            final_status = client.poll_deployment_status(deployment.id)
         except (TimeoutError, TooManyRetriesError, StreamLogError):
             progress.metadata["done_emoji"] = "⚠️"
             progress.current_message = (
@@ -168,6 +167,4 @@ def _wait_for_deployment(
     if build_complete:
         toolkit.print_line()
 
-        _verify_deployment(
-            toolkit=toolkit, client=client, app_id=app_id, deployment=deployment
-        )
+        _verify_deployment(toolkit=toolkit, client=client, deployment=deployment)

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/deployments.py

@@ -95,10 +95,8 @@ def _get_deployments(
     )
 
 
-def _get_deployment(
-    client: APIClient, *, app_id: str, deployment_id: str
-) -> DeploymentGetOutput:
-    response = client.get(f"/apps/{app_id}/deployments/{deployment_id}")
+def _get_deployment(client: APIClient, *, deployment_id: str) -> DeploymentGetOutput:
+    response = client.get(f"/deployments/{deployment_id}")
     response.raise_for_status()
 
     return DeploymentGetOutput(deployment=Deployment.model_validate(response.json()))
@@ -344,7 +342,7 @@ def get_deployment(
                 hint="Run `fastapi cloud login` or set FASTAPI_CLOUD_TOKEN.",
             )
 
-        target_app_id = resolve_app_id_or_fail(toolkit, app_id=app_id)
+        resolve_app_id_or_fail(toolkit, app_id=app_id)
 
         with APIClient() as client:
             with toolkit.progress(
@@ -359,7 +357,6 @@ def get_deployment(
                 ):
                     result = _get_deployment(
                         client,
-                        app_id=target_app_id,
                         deployment_id=deployment_id,
                     )
 

fastapi_cloud_cli-0.22.0/src/fastapi_cloud_cli/commands/logout.py

@@ -0,0 +1,30 @@
+from typing import Any
+
+from pydantic import BaseModel
+from rich_toolkit import RichToolkit
+
+from fastapi_cloud_cli.utils.auth import delete_auth_config
+from fastapi_cloud_cli.utils.cli import get_rich_toolkit
+from fastapi_cloud_cli.utils.execution import JsonOutputOption
+
+
+class LogoutOutput(BaseModel):
+    logged_out: bool
+
+
+def _render_logout_output(data: LogoutOutput, toolkit: RichToolkit) -> None:
+    toolkit.print_title("FastAPI Cloud")
+    toolkit.print_line()
+    toolkit.print("You are now logged out!", emoji="👋")
+
+
+def logout(json_output: JsonOutputOption = False) -> Any:
+    """
+    Logout from FastAPI Cloud.
+    """
+    with get_rich_toolkit(json_output=json_output) as toolkit:
+        delete_auth_config()
+        toolkit.success(
+            LogoutOutput(logged_out=True),
+            render_output=_render_logout_output,
+        )

{fastapi_cloud_cli-0.20.0 → fastapi_cloud_cli-0.22.0}/src/fastapi_cloud_cli/commands/logs.py

@@ -131,6 +131,12 @@ def _handle_stream_log_error(
         message = handle_http_error(error.__cause__)
         hint = get_http_error_hint(code)
 
+        if error.status_code == 400 and hint is None:
+            hint = (
+                "Try a shorter time range (e.g. `--since 1d`). "
+                "Log retention depends on your plan."
+            )
+
     else:
         code = "api_error"
         message = f"[red]Error:[/] {escape(str(error))}"
@@ -215,7 +221,10 @@ def logs(
         "5m",
         "--since",
         "-s",
-        help="Show logs since a specific time (e.g., '5m', '1h', '2d').",
+        help=(
+            "Show logs since a specific time (e.g., '5m', '1h', '2d'). "
+            "Limited by your plan's log retention."
+        ),
         show_default=True,
         callback=_validate_since,
     ),