♻️ Improve message around application directory (#191)

Author: patrick91

src/fastapi_cloud_cli/commands/deploy.py

@@ -378,10 +378,14 @@ def _configure_app(
     initial_directory = selected_app.directory if selected_app else ""
 
     directory_input = toolkit.input(
-        title="Path to the directory containing your app (e.g. src, backend):",
+        title=(
+            "Directory where your app's pyproject.toml file lives (e.g. src, backend):"
+        ),
         tag="dir",
         value=initial_directory or "",
-        placeholder="[italic]Leave empty if it's the current directory[/italic]",
+        placeholder=(
+            "[italic]Leave empty if pyproject.toml is in the current directory[/italic]"
+        ),
         validator=TypeAdapter(AppDirectory),
     )
 
@@ -665,7 +669,10 @@ def deploy(
     path: Annotated[
         Path | None,
         typer.Argument(
-            help="A path to the folder containing the app you want to deploy"
+            help=(
+                "Path to the directory with your app's pyproject.toml "
+                "(defaults to current directory)"
+            )
         ),
     ] = None,
     skip_wait: Annotated[

src/fastapi_cloud_cli/commands/env.py

@@ -61,7 +61,10 @@ def list(
     path: Annotated[
         Path | None,
         typer.Argument(
-            help="A path to the folder containing the app you want to deploy"
+            help=(
+                "Path to the directory with your app's pyproject.toml "
+                "(defaults to current directory)"
+            )
         ),
     ] = None,
 ) -> Any:
@@ -119,7 +122,10 @@ def delete(
     path: Annotated[
         Path | None,
         typer.Argument(
-            help="A path to the folder containing the app you want to deploy"
+            help=(
+                "Path to the directory with your app's pyproject.toml "
+                "(defaults to current directory)"
+            )
         ),
     ] = None,
 ) -> Any:
@@ -208,7 +214,10 @@ def set(
     path: Annotated[
         Path | None,
         typer.Argument(
-            help="A path to the folder containing the app you want to deploy"
+            help=(
+                "Path to the directory with your app's pyproject.toml "
+                "(defaults to current directory)"
+            )
         ),
     ] = None,
     secret: Annotated[

src/fastapi_cloud_cli/commands/logs.py

@@ -113,7 +113,10 @@ def logs(
     path: Annotated[
         Path | None,
         typer.Argument(
-            help="Path to the folder containing the app (defaults to current directory)"
+            help=(
+                "Path to the directory with your app's pyproject.toml "
+                "(defaults to current directory)"
+            )
         ),
     ] = None,
     tail: int = typer.Option(

src/fastapi_cloud_cli/commands/setup_ci.py

@@ -157,7 +157,10 @@ def setup_ci(
     path: Annotated[
         Path | None,
         typer.Argument(
-            help="Path to the folder containing the app (defaults to current directory)"
+            help=(
+                "Path to the directory with your app's pyproject.toml "
+                "(defaults to current directory)"
+            )
         ),
     ] = None,
     branch: str | None = typer.Option(

tests/test_cli_deploy.py

@@ -528,6 +528,7 @@ def test_creates_app_with_directory(
         assert result.exit_code == 1
 
         assert "App created successfully" in result.output
+        assert "Directory where your app's pyproject.toml file lives" in result.output
         assert "Directory: src" in result.output