fastapi-cloud-cli 0.14.1__tar.gz → 0.15.1__tar.gz

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-cloud-cli
-Version: 0.14.1
+Version: 0.15.1
 Summary: Deploy and manage FastAPI Cloud apps from the command line 🚀
 Author-Email: Patrick Arminio <patrick@fastapilabs.com>
 License: MIT

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/pyproject.toml

@@ -40,7 +40,7 @@ dependencies = [
     "sentry-sdk >= 2.20.0",
     "fastar >= 0.8.0",
 ]
-version = "0.14.1"
+version = "0.15.1"
 
 [project.license]
 text = "MIT"
@@ -66,6 +66,7 @@ dev = [
     "ruff==0.13.0",
     "respx==0.22.0",
     "time-machine==2.15.0",
+    "ty>=0.0.9",
 ]
 
 [build-system]
@@ -128,6 +129,11 @@ exclude = [
     "tests/assets/*",
 ]
 
+[tool.ty.src]
+exclude = [
+    "tests/assets/**",
+]
+
 [tool.ruff.lint]
 select = [
     "E",

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/scripts/lint.sh

@@ -4,5 +4,6 @@ set -e
 set -x
 
 mypy src tests
+ty check src tests
 ruff check src tests scripts
 ruff format src tests --check

fastapi_cloud_cli-0.15.1/src/fastapi_cloud_cli/__init__.py

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

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/src/fastapi_cloud_cli/cli.py

@@ -6,6 +6,7 @@ from .commands.link import link
 from .commands.login import login
 from .commands.logout import logout
 from .commands.logs import logs
+from .commands.setup_ci import setup_ci
 from .commands.unlink import unlink
 from .commands.whoami import whoami
 from .logging import setup_logging
@@ -32,6 +33,7 @@ cloud_app.command()(logs)
 cloud_app.command()(logout)
 cloud_app.command()(whoami)
 cloud_app.command()(unlink)
+cloud_app.command()(setup_ci)
 
 cloud_app.add_typer(env_app, name="env")
 

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/src/fastapi_cloud_cli/commands/deploy.py

@@ -304,6 +304,7 @@ def _configure_app(toolkit: RichToolkit, path_to_deploy: Path) -> AppConfig:
         "Select the team you want to deploy to:",
         tag="team",
         options=[Option({"name": team.name, "value": team}) for team in teams],
+        allow_filtering=True,
     )
 
     toolkit.print_line()
@@ -335,6 +336,7 @@ def _configure_app(toolkit: RichToolkit, path_to_deploy: Path) -> AppConfig:
         selected_app = toolkit.ask(
             "Select the app you want to deploy to:",
             options=[Option({"name": app.slug, "value": app}) for app in apps],
+            allow_filtering=True,
         )
 
     app_name = (
@@ -478,7 +480,7 @@ def _wait_for_deployment(
                     time_elapsed = time.monotonic() - started_at
 
                     if log.type == "message":
-                        progress.log(Text.from_ansi(log.message.rstrip()))
+                        progress.log(Text.from_ansi(log.message.rstrip()))  # ty: ignore[unresolved-attribute]
 
                     if log.type == "complete":
                         build_complete = True
@@ -581,13 +583,13 @@ def _waitlist_form(toolkit: RichToolkit) -> None:
         )
         form.add_input("secret_code", label="Secret code", placeholder="123456")
 
-        result = form.run()  # type: ignore
+        result = form.run()  # type: ignore  # ty: ignore[unused-ignore-comment]
 
         try:
             result = SignupToWaitingList.model_validate(
                 {
                     "email": email,
-                    **result,  # type: ignore
+                    **result,  # type: ignore  # ty: ignore[unused-ignore-comment]
                 },
             )
         except ValidationError:

fastapi_cloud_cli-0.15.1/src/fastapi_cloud_cli/commands/setup_ci.py

@@ -0,0 +1,360 @@
+import logging
+import re
+import shutil
+import subprocess
+from pathlib import Path
+from typing import Annotated
+
+import typer
+
+from fastapi_cloud_cli.utils.api import APIClient
+from fastapi_cloud_cli.utils.apps import get_app_config
+from fastapi_cloud_cli.utils.auth import Identity
+from fastapi_cloud_cli.utils.cli import get_rich_toolkit, handle_http_errors
+
+logger = logging.getLogger(__name__)
+
+TOKEN_EXPIRES_DAYS = 365
+DEFAULT_WORKFLOW_PATH = Path(".github/workflows/deploy.yml")
+
+
+class GitHubSecretError(Exception):
+    """Raised when setting a GitHub Actions secret fails."""
+
+    pass
+
+
+def _get_github_host(origin: str) -> str:
+    """Extract the GitHub host from a git remote URL.
+
+    Supports both github.com and GitHub Enterprise hosts.
+    Examples:
+        git@github.com:owner/repo.git -> github.com
+        https://github.com/owner/repo.git -> github.com
+        git@enterprise.github.com:owner/repo.git -> enterprise.github.com
+    """
+    # Match git@HOST:owner/repo or https://HOST/owner/repo
+    match = re.search(r"(?:git@|https://)([^:/]+)", origin)
+    return match.group(1) if match else "github.com"
+
+
+def _repo_slug_from_origin(origin: str) -> str | None:
+    """Extract 'owner/repo' from a GitHub remote URL."""
+    # Handles URLs like: git@github.com:owner/repo.git or https://github.com/owner/repo.git
+    # Also supports GitHub Enterprise hosts like git@github.enterprise.com:owner/repo.git
+    # Match the part after the last : or / (which is owner/repo)
+    match = re.search(r"[:/]([^:/]+/[^/]+?)(?:\.git)?$", origin)
+    return match.group(1) if match else None
+
+
+def _check_git_installed() -> bool:
+    """Check if git is installed and available."""
+    return shutil.which("git") is not None
+
+
+def _check_gh_cli_installed() -> bool:
+    """Check if the GitHub CLI (gh) is installed and available."""
+    return shutil.which("gh") is not None
+
+
+def _get_remote_origin() -> str:
+    """Get the remote origin URL of the Git repository."""
+    try:
+        # Try gh first (to respect gh repo set-default)
+        result = subprocess.run(
+            ["gh", "repo", "view", "--json", "url", "-q", ".url"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        return result.stdout.strip()
+    # CalledProcessError if gh command fails, FileNotFoundError if gh is not installed
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        # Fallback to git command
+        result = subprocess.run(
+            ["git", "config", "--get", "remote.origin.url"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        return result.stdout.strip()
+
+
+def _set_github_secret(name: str, value: str) -> None:
+    """Set a GitHub Actions secret via the gh CLI.
+
+    Raises:
+        GitHubSecretError: If setting the secret fails.
+    """
+    try:
+        subprocess.run(
+            ["gh", "secret", "set", name, "--body", value],
+            capture_output=True,
+            check=True,
+        )
+    except (subprocess.CalledProcessError, FileNotFoundError) as e:
+        raise GitHubSecretError(f"Failed to set GitHub secret '{name}'") from e
+
+
+def _create_token(app_id: str, token_name: str) -> dict[str, str]:
+    """Create a new deploy token.
+
+    Returns token_data dict with 'value' and 'expired_at' keys.
+    """
+    with APIClient() as client:
+        response = client.post(
+            f"/apps/{app_id}/tokens",
+            json={"name": token_name, "expires_in_days": TOKEN_EXPIRES_DAYS},
+        )
+        response.raise_for_status()
+        data = response.json()
+        return {"value": data["value"], "expired_at": data["expired_at"]}
+
+
+def _get_default_branch() -> str:
+    """Get the default branch of the Git repository."""
+    try:
+        result = subprocess.run(
+            [
+                "gh",
+                "repo",
+                "view",
+                "--json",
+                "defaultBranchRef",
+                "-q",
+                ".defaultBranchRef.name",
+            ],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+        return result.stdout.strip()
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        return "main"
+
+
+def _write_workflow_file(branch: str, workflow_path: Path) -> None:
+    workflow_content = f"""\
+name: Deploy to FastAPI Cloud
+on:
+  push:
+    branches: [{branch}]
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: astral-sh/setup-uv@v7
+      - run: uv run fastapi deploy
+        env:
+          FASTAPI_CLOUD_TOKEN: ${{{{ secrets.FASTAPI_CLOUD_TOKEN }}}}
+          FASTAPI_CLOUD_APP_ID: ${{{{ secrets.FASTAPI_CLOUD_APP_ID }}}}
+"""
+    workflow_path.parent.mkdir(parents=True, exist_ok=True)
+    workflow_path.write_text(workflow_content)
+
+
+def setup_ci(
+    path: Annotated[
+        Path | None,
+        typer.Argument(
+            help="Path to the folder containing the app (defaults to current directory)"
+        ),
+    ] = None,
+    branch: str | None = typer.Option(
+        None,
+        "--branch",
+        "-b",
+        help="Branch that triggers deploys (defaults to the repo's default branch)",
+    ),
+    secrets_only: bool = typer.Option(
+        False,
+        "--secrets-only",
+        "-s",
+        help="Provisions token and sets secrets, skips writing the workflow file",
+        show_default=True,
+    ),
+    dry_run: bool = typer.Option(
+        False,
+        "--dry-run",
+        "-d",
+        help="Prints steps that would be taken without actually performing them",
+        show_default=True,
+    ),
+    file: str | None = typer.Option(
+        None,
+        "--file",
+        "-f",
+        help="Custom workflow filename (written to .github/workflows/)",
+    ),
+) -> None:
+    """Configures a GitHub Actions workflow for deploying the app on push to the specified branch.
+
+    Examples:
+        fastapi cloud setup-ci                      # Provisions token, sets secrets, and writes workflow file for the 'main' branch
+        fastapi cloud setup-ci --branch develop     # Same as above but for the 'develop' branch
+        fastapi cloud setup-ci --secrets-only       # Only provisions token and sets secrets, does not write workflow file
+        fastapi cloud setup-ci --dry-run            # Prints the steps that would be taken without performing them
+        fastapi cloud setup-ci --file ci.yml        # Writes workflow to .github/workflows/ci.yml
+    """
+
+    identity = Identity()
+
+    with get_rich_toolkit() as toolkit:
+        if not identity.is_logged_in():
+            toolkit.print(
+                "No credentials found. Use [blue]`fastapi login`[/] to login.",
+                tag="auth",
+            )
+            raise typer.Exit(1)
+
+        app_path = path or Path.cwd()
+        app_config = get_app_config(app_path)
+
+        if not app_config:
+            toolkit.print(
+                "No app linked to this directory. Run [blue]`fastapi deploy`[/] first.",
+                tag="error",
+            )
+            raise typer.Exit(1)
+
+        if not _check_git_installed():
+            toolkit.print(
+                "git is not installed. Please install git to use this command.",
+                tag="error",
+            )
+            raise typer.Exit(1)
+
+        try:
+            origin = _get_remote_origin()
+        except subprocess.CalledProcessError:
+            toolkit.print(
+                "Error retrieving git remote origin URL. Make sure you're in a git repository with a remote origin set.",
+                tag="error",
+            )
+            raise typer.Exit(1) from None
+
+        # Check if it's a GitHub host (github.com or GitHub Enterprise)
+        if "github" not in origin.lower():
+            toolkit.print(
+                "Remote origin is not a GitHub repository. Please set up a GitHub repo and add it as the remote origin.",
+                tag="error",
+            )
+            raise typer.Exit(1)
+
+        repo_slug = _repo_slug_from_origin(origin) or origin
+        github_host = _get_github_host(origin)
+        has_gh = _check_gh_cli_installed()
+
+        if not branch:
+            branch = _get_default_branch()
+
+        if dry_run:
+            toolkit.print(
+                "[yellow]This is a dry run — no changes will be made[/yellow]"
+            )
+            toolkit.print_line()
+
+        toolkit.print_title("Configuring CI", tag="FastAPI")
+        toolkit.print_line()
+
+        toolkit.print(f"Setting up CI for [bold]{repo_slug}[/bold] (branch: {branch})")
+        toolkit.print_line()
+
+        msg_token = "Created deploy token"
+        msg_secrets = (
+            "Set [bold]FASTAPI_CLOUD_TOKEN[/bold] and [bold]FASTAPI_CLOUD_APP_ID[/bold]"
+        )
+        workflow_file = file or DEFAULT_WORKFLOW_PATH.name
+        msg_workflow = (
+            f"Wrote [bold].github/workflows/{workflow_file}[/bold] (branch: {branch})"
+        )
+        msg_done = "Done — commit and push to start deploying."
+
+        if dry_run:
+            toolkit.print(msg_token)
+            toolkit.print(msg_secrets)
+            if not secrets_only:
+                toolkit.print(msg_workflow)
+            return
+
+        from datetime import datetime, timezone
+
+        # Create unique token name with timestamp to avoid duplicates
+        timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M UTC")
+        token_name = f"GitHub Actions — {repo_slug} ({timestamp})"
+
+        with (
+            toolkit.progress(title="Generating deploy token...") as progress,
+            handle_http_errors(
+                progress, default_message="Error creating deploy token."
+            ),
+        ):
+            token_data = _create_token(app_config.app_id, token_name)
+            progress.log(msg_token)
+
+        toolkit.print_line()
+
+        if has_gh:
+            with toolkit.progress(title="Setting repo secrets...") as progress:
+                try:
+                    _set_github_secret("FASTAPI_CLOUD_TOKEN", token_data["value"])
+                    _set_github_secret("FASTAPI_CLOUD_APP_ID", app_config.app_id)
+                except GitHubSecretError:
+                    progress.set_error("Failed to set GitHub secrets via gh CLI.")
+                    raise typer.Exit(1) from None
+                progress.log(msg_secrets)
+        else:
+            secrets_url = f"https://{github_host}/{repo_slug}/settings/secrets/actions"
+            toolkit.print(
+                "[yellow]gh CLI not found. Set these secrets manually:[/yellow]",
+                tag="info",
+            )
+            toolkit.print_line()
+            toolkit.print(f"  Repository: [blue]{secrets_url}[/]")
+            toolkit.print_line()
+            toolkit.print(f"  [bold]FASTAPI_CLOUD_TOKEN[/bold] = {token_data['value']}")
+            toolkit.print(f"  [bold]FASTAPI_CLOUD_APP_ID[/bold] = {app_config.app_id}")
+
+        toolkit.print_line()
+
+        if not secrets_only:
+            if file:
+                workflow_path = Path(f".github/workflows/{file}")
+            else:
+                workflow_path = DEFAULT_WORKFLOW_PATH
+
+            write_workflow = True
+            if not file and workflow_path.exists():
+                overwrite = toolkit.confirm(
+                    f"Workflow file [bold]{workflow_path}[/bold] already exists. Overwrite?",
+                    tag="workflow",
+                    default=False,
+                )
+                if not overwrite:
+                    new_name = toolkit.input(
+                        "Enter a new filename (without path) or leave blank to skip writing the workflow file:",
+                        tag="workflow",
+                    ).strip()
+                    if new_name:
+                        workflow_path = Path(f".github/workflows/{new_name}")
+                    else:
+                        toolkit.print("Skipped writing workflow file.")
+                        toolkit.print_line()
+                        write_workflow = False
+                toolkit.print_line()
+            if write_workflow:
+                msg_workflow = f"Wrote [bold]{workflow_path}[/bold] (branch: {branch})"
+                with toolkit.progress(title="Writing workflow file...") as progress:
+                    _write_workflow_file(branch, workflow_path)
+                    progress.log(msg_workflow)
+
+                toolkit.print_line()
+
+        toolkit.print(msg_done)
+        toolkit.print_line()
+        # Token expiration date is in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ), extract date portion
+        toolkit.print(
+            f"Your deploy token expires on [bold]{token_data['expired_at'][:10]}[/bold]. "
+            "Regenerate it from the dashboard or re-run this command before then.",
+        )

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/tests/test_api_client.py

@@ -55,10 +55,10 @@ def test_stream_build_logs_successful(
     assert len(logs) == 3
 
     assert logs[0].type == "message"
-    assert logs[0].message == "Building..."
+    assert logs[0].message == "Building..."  # ty: ignore[unresolved-attribute]
 
     assert logs[1].type == "message"
-    assert logs[1].message == "Done!"
+    assert logs[1].message == "Done!"  # ty: ignore[unresolved-attribute]
 
     assert logs[2].type == "complete"
 
@@ -201,7 +201,7 @@ def test_stream_build_logs_network_error_retry(
 
     assert len(logs) == 2
     assert logs[0].type == "message"
-    assert logs[0].message == "Success after retry"
+    assert logs[0].message == "Success after retry"  # ty: ignore[unresolved-attribute]
 
 
 def test_stream_build_logs_server_error_retry(

{fastapi_cloud_cli-0.14.1 → fastapi_cloud_cli-0.15.1}/tests/test_cli_deploy.py

@@ -24,8 +24,8 @@ runner = CliRunner()
 assets_path = Path(__file__).parent / "assets"
 
 
-def _get_random_team() -> dict[str, str]:
-    name = "".join(random.choices(string.ascii_lowercase, k=10))
+def _get_random_team(name: str | None = None) -> dict[str, str]:
+    name = name or "".join(random.choices(string.ascii_lowercase, k=10))
     slug = "".join(random.choices(string.ascii_lowercase, k=10))
     id = "".join(random.choices(string.digits, k=10))
 
@@ -323,6 +323,42 @@ def test_shows_teams(
         assert team_2["name"] in result.output
 
 
+@pytest.mark.respx
+def test_filter_teams(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    steps = [*"al", Keys.ENTER, Keys.CTRL_C]
+
+    team_1 = _get_random_team(name="Alpha Team")
+    team_2 = _get_random_team(name="Beta Team")
+
+    respx_mock.get("/teams/").mock(
+        return_value=Response(
+            200,
+            json={"data": [team_1, team_2]},
+        )
+    )
+
+    with (
+        changing_dir(tmp_path),
+        patch("rich_toolkit.container.getchar") as mock_getchar,
+    ):
+        mock_getchar.side_effect = steps
+
+        result = runner.invoke(app, ["deploy"])
+
+        assert result.exit_code == 1
+
+        assert "Filter: al" in result.output
+
+        # Truncate part of the output before "Filter: al"
+        filer_pos = result.output.rfind("Filter: al")
+        last_output = result.output[filer_pos:]
+
+        assert team_1["name"] in last_output
+        assert team_2["name"] not in last_output
+
+
 @pytest.mark.respx
 def test_asks_for_app_name_after_team(
     logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
@@ -349,6 +385,48 @@ def test_asks_for_app_name_after_team(
         assert "What's your app name?" in result.output
 
 
+@pytest.mark.respx
+def test_filter_apps(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    steps = [Keys.ENTER, Keys.RIGHT_ARROW, Keys.ENTER, *"an", Keys.ENTER, Keys.CTRL_C]
+
+    team = _get_random_team()
+
+    respx_mock.get("/teams/").mock(
+        return_value=Response(
+            200,
+            json={"data": [team]},
+        )
+    )
+
+    app_1 = _get_random_app(team_id=team["id"], slug="My App")
+    app_2 = _get_random_app(team_id=team["id"], slug="Another App")
+
+    respx_mock.get("/apps/", params={"team_id": team["id"]}).mock(
+        return_value=Response(200, json={"data": [app_1, app_2]})
+    )
+
+    with (
+        changing_dir(tmp_path),
+        patch("rich_toolkit.container.getchar") as mock_getchar,
+    ):
+        mock_getchar.side_effect = steps
+
+        result = runner.invoke(app, ["deploy"])
+
+        assert result.exit_code == 1
+
+        assert "Filter: an" in result.output
+
+        # Truncate part of the output before "Filter: an"
+        filer_pos = result.output.rfind("Filter: an")
+        last_output = result.output[filer_pos:]
+
+        assert app_1["slug"] not in last_output
+        assert app_2["slug"] in last_output
+
+
 @pytest.mark.respx
 def test_creates_app_on_backend(
     logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter