sprout-cli 0.4.0__tar.gz → 0.6.0__tar.gz

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sprout-cli
-Version: 0.4.0
+Version: 0.6.0
 Summary: CLI tool to automate git worktree and Docker Compose development workflows
 Author: SecDevLab Inc.
 License: MIT
@@ -41,7 +41,7 @@ A CLI tool to automate git worktree and Docker Compose development workflows.
 ## Installation
 
 ```bash
-pip install sprout
+pip install sprout-cli
 ```
 
 For development:
@@ -56,7 +56,9 @@ pip install -e ".[dev]"
 
 ## Quick Start
 
-1. Create a `.env.example` template in your project root (and optionally in subdirectories):
+**Note**: Sprout works in any git repository. `.env.example` files are optional - if you don't have them, sprout will simply create worktrees without `.env` generation.
+
+1. (Optional) Create a `.env.example` template in your project root (and optionally in subdirectories) for automatic `.env` generation:
 ```env
 # API Configuration
 API_KEY={{ API_KEY }}
@@ -66,6 +68,10 @@ API_PORT={{ auto_port() }}
 DB_HOST=localhost
 DB_PORT={{ auto_port() }}
 
+# Branch-specific Configuration
+SERVICE_NAME=myapp-{{ branch() }}
+DEPLOYMENT_ENV={{ branch() }}
+
 # Example: Docker Compose variables (preserved as-is)
 # sprout will NOT process ${...} syntax - it's passed through unchanged
 # DB_NAME=${DB_NAME}
@@ -86,9 +92,13 @@ repo/
 cd $(sprout create feature-branch --path)
 ```
 
+**What happens when you run `sprout create`:**
+- If `.env.example` files exist: Sprout will generate corresponding `.env` files with populated variables and unique port assignments
+- If no `.env.example` files exist: Sprout will show a warning and create the worktree without `.env` generation
+
 This single command:
 - Creates a new git worktree for `feature-branch`
-- Generates a `.env` file from your template
+- Generates `.env` files from your templates (if `.env.example` files exist)
 - Outputs the path to the new environment
 - Changes to that directory when wrapped in `cd $(...)`
 
@@ -174,7 +184,7 @@ Show the version of sprout.
 
 ## Template Syntax
 
-sprout supports two types of placeholders in `.env.example`:
+sprout supports three types of placeholders in `.env.example`:
 
 1. **Variable Placeholders**: `{{ VARIABLE_NAME }}`
    - **First**: Checks if the variable exists in your environment (e.g., `export API_KEY=xxx`)
@@ -187,7 +197,12 @@ sprout supports two types of placeholders in `.env.example`:
    - Checks system port availability
    - Ensures global uniqueness even in monorepo setups
 
-3. **Docker Compose Syntax (Preserved)**: `${VARIABLE}`
+3. **Branch Name**: `{{ branch() }}`
+   - Replaced with the current branch/subtree name
+   - Useful for branch-specific configurations
+   - Example: `SERVICE_NAME=myapp-{{ branch() }}` becomes `SERVICE_NAME=myapp-feature-auth`
+
+4. **Docker Compose Syntax (Preserved)**: `${VARIABLE}`
    - NOT processed by sprout - passed through as-is
    - Useful for Docker Compose variable substitution
    - Example: `${DB_NAME:-default}` remains unchanged in generated `.env`

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/README.md

@@ -13,7 +13,7 @@ A CLI tool to automate git worktree and Docker Compose development workflows.
 ## Installation
 
 ```bash
-pip install sprout
+pip install sprout-cli
 ```
 
 For development:
@@ -28,7 +28,9 @@ pip install -e ".[dev]"
 
 ## Quick Start
 
-1. Create a `.env.example` template in your project root (and optionally in subdirectories):
+**Note**: Sprout works in any git repository. `.env.example` files are optional - if you don't have them, sprout will simply create worktrees without `.env` generation.
+
+1. (Optional) Create a `.env.example` template in your project root (and optionally in subdirectories) for automatic `.env` generation:
 ```env
 # API Configuration
 API_KEY={{ API_KEY }}
@@ -38,6 +40,10 @@ API_PORT={{ auto_port() }}
 DB_HOST=localhost
 DB_PORT={{ auto_port() }}
 
+# Branch-specific Configuration
+SERVICE_NAME=myapp-{{ branch() }}
+DEPLOYMENT_ENV={{ branch() }}
+
 # Example: Docker Compose variables (preserved as-is)
 # sprout will NOT process ${...} syntax - it's passed through unchanged
 # DB_NAME=${DB_NAME}
@@ -58,9 +64,13 @@ repo/
 cd $(sprout create feature-branch --path)
 ```
 
+**What happens when you run `sprout create`:**
+- If `.env.example` files exist: Sprout will generate corresponding `.env` files with populated variables and unique port assignments
+- If no `.env.example` files exist: Sprout will show a warning and create the worktree without `.env` generation
+
 This single command:
 - Creates a new git worktree for `feature-branch`
-- Generates a `.env` file from your template
+- Generates `.env` files from your templates (if `.env.example` files exist)
 - Outputs the path to the new environment
 - Changes to that directory when wrapped in `cd $(...)`
 
@@ -146,7 +156,7 @@ Show the version of sprout.
 
 ## Template Syntax
 
-sprout supports two types of placeholders in `.env.example`:
+sprout supports three types of placeholders in `.env.example`:
 
 1. **Variable Placeholders**: `{{ VARIABLE_NAME }}`
    - **First**: Checks if the variable exists in your environment (e.g., `export API_KEY=xxx`)
@@ -159,7 +169,12 @@ sprout supports two types of placeholders in `.env.example`:
    - Checks system port availability
    - Ensures global uniqueness even in monorepo setups
 
-3. **Docker Compose Syntax (Preserved)**: `${VARIABLE}`
+3. **Branch Name**: `{{ branch() }}`
+   - Replaced with the current branch/subtree name
+   - Useful for branch-specific configurations
+   - Example: `SERVICE_NAME=myapp-{{ branch() }}` becomes `SERVICE_NAME=myapp-feature-auth`
+
+4. **Docker Compose Syntax (Preserved)**: `${VARIABLE}`
    - NOT processed by sprout - passed through as-is
    - Useful for Docker Compose variable substitution
    - Example: `${DB_NAME:-default}` remains unchanged in generated `.env`

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/src/sprout/__init__.py

@@ -1,3 +1,3 @@
 """sprout - CLI tool to automate git worktree and Docker Compose development workflows."""
 
-__version__ = "0.4.0"
+__version__ = "0.6.0"

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/src/sprout/commands/create.py

@@ -47,11 +47,9 @@ def create_worktree(branch_name: BranchName, path_only: bool = False) -> Never:
 
     if not env_examples:
         if not path_only:
-            console.print("[red]Error: No .env.example files found[/red]")
-            console.print(f"Expected at least one .env.example file in: {git_root}")
-        else:
-            typer.echo(f"Error: No .env.example files found in {git_root}", err=True)
-        raise typer.Exit(1)
+            console.print("[yellow]Warning: No .env.example files found[/yellow]")
+            console.print(f"Proceeding without .env generation in: {git_root}")
+        # Continue execution without exiting
 
     # Check if worktree already exists
     if worktree_exists(branch_name):
@@ -87,58 +85,62 @@ def create_worktree(branch_name: BranchName, path_only: bool = False) -> Never:
             typer.echo(f"Error creating worktree: {e}", err=True)
         raise typer.Exit(1) from e
 
-    # Generate .env files
-    if not path_only:
-        console.print(f"Generating .env files from {len(env_examples)} template(s)...")
-
-    # Get all currently used ports to avoid conflicts
-    all_used_ports = get_used_ports()
-    session_ports: set[int] = set()
-
-    try:
-        for env_example in env_examples:
-            # Calculate relative path from git root
-            relative_dir = env_example.parent.relative_to(git_root)
-
-            # Create target directory in worktree if needed
-            if relative_dir != Path("."):
-                target_dir = worktree_path / relative_dir
-                target_dir.mkdir(parents=True, exist_ok=True)
-                env_file = target_dir / ".env"
-            else:
-                env_file = worktree_path / ".env"
-
-            # Parse template with combined used ports
-            env_content = parse_env_template(
-                env_example, silent=path_only, used_ports=all_used_ports | session_ports
-            )
-
-            # Extract ports from generated content and add to session_ports
-            port_matches = re.findall(r"=(\d{4,5})\b", env_content)
-            for port_str in port_matches:
-                port = int(port_str)
-                if 1024 <= port <= 65535:
-                    session_ports.add(port)
-
-            # Write the .env file
-            env_file.write_text(env_content)
-
-    except SproutError as e:
-        if not path_only:
-            console.print(f"[red]Error generating .env file: {e}[/red]")
-        else:
-            typer.echo(f"Error generating .env file: {e}", err=True)
-        # Clean up worktree on failure
-        run_command(["git", "worktree", "remove", str(worktree_path)], check=False)
-        raise typer.Exit(1) from e
-    except KeyboardInterrupt:
+    # Generate .env files only if .env.example files exist
+    if env_examples:
         if not path_only:
-            console.print("\n[yellow]Cancelled by user[/yellow]")
-        else:
-            typer.echo("Cancelled by user", err=True)
-        # Clean up worktree on cancellation
-        run_command(["git", "worktree", "remove", str(worktree_path)], check=False)
-        raise typer.Exit(130) from None
+            console.print(f"Generating .env files from {len(env_examples)} template(s)...")
+
+        # Get all currently used ports to avoid conflicts
+        all_used_ports = get_used_ports()
+        session_ports: set[int] = set()
+
+        try:
+            for env_example in env_examples:
+                # Calculate relative path from git root
+                relative_dir = env_example.parent.relative_to(git_root)
+
+                # Create target directory in worktree if needed
+                if relative_dir != Path("."):
+                    target_dir = worktree_path / relative_dir
+                    target_dir.mkdir(parents=True, exist_ok=True)
+                    env_file = target_dir / ".env"
+                else:
+                    env_file = worktree_path / ".env"
+
+                # Parse template with combined used ports
+                env_content = parse_env_template(
+                    env_example,
+                    silent=path_only,
+                    used_ports=all_used_ports | session_ports,
+                    branch_name=branch_name,
+                )
+
+                # Extract ports from generated content and add to session_ports
+                port_matches = re.findall(r"=(\d{4,5})\b", env_content)
+                for port_str in port_matches:
+                    port = int(port_str)
+                    if 1024 <= port <= 65535:
+                        session_ports.add(port)
+
+                # Write the .env file
+                env_file.write_text(env_content)
+
+        except SproutError as e:
+            if not path_only:
+                console.print(f"[red]Error generating .env file: {e}[/red]")
+            else:
+                typer.echo(f"Error generating .env file: {e}", err=True)
+            # Clean up worktree on failure
+            run_command(["git", "worktree", "remove", str(worktree_path)], check=False)
+            raise typer.Exit(1) from e
+        except KeyboardInterrupt:
+            if not path_only:
+                console.print("\n[yellow]Cancelled by user[/yellow]")
+            else:
+                typer.echo("Cancelled by user", err=True)
+            # Clean up worktree on cancellation
+            run_command(["git", "worktree", "remove", str(worktree_path)], check=False)
+            raise typer.Exit(130) from None
 
     # Success message or path output
     if path_only:
@@ -146,8 +148,17 @@ def create_worktree(branch_name: BranchName, path_only: bool = False) -> Never:
         print(str(worktree_path))
     else:
         console.print(f"\n[green]✅ Workspace '{branch_name}' created successfully![/green]\n")
+        if env_examples:
+            console.print(f"Generated .env files from {len(env_examples)} template(s)")
+        else:
+            console.print("No .env files generated (no .env.example templates found)")
         console.print("Navigate to your new environment with:")
-        console.print(f"  [cyan]cd {worktree_path.relative_to(Path.cwd())}[/cyan]")
+        try:
+            relative_path = worktree_path.relative_to(Path.cwd())
+            console.print(f"  [cyan]cd {relative_path}[/cyan]")
+        except ValueError:
+            # If worktree_path is not relative to current directory, show absolute path
+            console.print(f"  [cyan]cd {worktree_path}[/cyan]")
 
     # Exit successfully
     raise typer.Exit(0)

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/src/sprout/utils.py

@@ -126,7 +126,10 @@ def find_available_port() -> PortNumber:
 
 
 def parse_env_template(
-    template_path: Path, silent: bool = False, used_ports: PortSet | None = None
+    template_path: Path,
+    silent: bool = False,
+    used_ports: PortSet | None = None,
+    branch_name: str | None = None,
 ) -> str:
     """Parse .env.example template and process placeholders.
 
@@ -134,6 +137,7 @@ def parse_env_template(
         template_path: Path to the .env.example template file
         silent: If True, use stderr for prompts to keep stdout clean
         used_ports: Set of ports already in use (in addition to system-wide used ports)
+        branch_name: Branch name to use for {{ branch() }} placeholders
     """
     if not template_path.exists():
         raise SproutError(f".env.example file not found at {template_path}")
@@ -161,6 +165,10 @@ def parse_env_template(
 
         line = re.sub(r"{{\s*auto_port\(\)\s*}}", replace_auto_port, line)
 
+        # Process {{ branch() }} placeholders
+        if branch_name:
+            line = re.sub(r"{{\s*branch\(\)\s*}}", branch_name, line)
+
         # Process {{ VARIABLE }} placeholders
         def replace_variable(match: re.Match[str]) -> str:
             var_name = match.group(1).strip()
@@ -187,7 +195,8 @@ def parse_env_template(
                     value = console.input(prompt)
             return value
 
-        line = re.sub(r"{{\s*([^}]+)\s*}}", replace_variable, line)
+        # Only match variables that don't look like function calls (no parentheses)
+        line = re.sub(r"{{\s*([^}()]+)\s*}}", replace_variable, line)
 
         lines.append(line)
 

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/tests/test_commands.py

@@ -126,20 +126,37 @@ class TestCreateCommand:
         # stdout should be empty
         assert result.stdout == ""
 
-    def test_create_no_env_example(self, mocker):
-        """Test error when .env.example doesn't exist."""
+    def test_create_no_env_example(self, mocker, tmp_path):
+        """Test success when .env.example doesn't exist."""
         mocker.patch("sprout.commands.create.is_git_repository", return_value=True)
-        mock_git_root = Path("/project")
+        mock_git_root = tmp_path / "project"
+        mock_git_root.mkdir()
         mocker.patch("sprout.commands.create.get_git_root", return_value=mock_git_root)
+        mocker.patch("sprout.commands.create.worktree_exists", return_value=False)
+        sprout_dir = tmp_path / ".sprout"
+        sprout_dir.mkdir()
+        mocker.patch("sprout.commands.create.ensure_sprout_dir", return_value=sprout_dir)
+        mocker.patch("sprout.commands.create.branch_exists", return_value=False)
 
-        # Mock git ls-files to return empty list
+        # Mock git ls-files to return empty list (no .env.example files)
         mock_run = mocker.patch("sprout.commands.create.run_command")
         mock_run.return_value = Mock(stdout="", returncode=0)
 
-        result = runner.invoke(app, ["create", "feature-branch"])
+        # Change to project directory to make relative path calculation work
+        import os
 
-        assert result.exit_code == 1
-        assert "No .env.example files found" in result.stdout
+        old_cwd = os.getcwd()
+        os.chdir(str(mock_git_root))
+
+        try:
+            result = runner.invoke(app, ["create", "feature-branch"])
+
+            assert result.exit_code == 0
+            assert "Warning: No .env.example files found" in result.stdout
+            assert "Workspace 'feature-branch' created successfully!" in result.stdout
+            assert "No .env files generated (no .env.example templates found)" in result.stdout
+        finally:
+            os.chdir(old_cwd)
 
     def test_create_worktree_exists(self, mocker):
         """Test error when worktree already exists."""
@@ -161,6 +178,28 @@ class TestCreateCommand:
         assert result.exit_code == 1
         assert "Worktree for branch 'feature-branch' already exists" in result.stdout
 
+    def test_create_without_env_example_path_mode(self, mocker, tmp_path):
+        """Test path mode with no .env.example files."""
+        mocker.patch("sprout.commands.create.is_git_repository", return_value=True)
+        mock_git_root = tmp_path / "project"
+        mock_git_root.mkdir()
+        mocker.patch("sprout.commands.create.get_git_root", return_value=mock_git_root)
+        mocker.patch("sprout.commands.create.worktree_exists", return_value=False)
+        sprout_dir = tmp_path / ".sprout"
+        sprout_dir.mkdir()
+        mocker.patch("sprout.commands.create.ensure_sprout_dir", return_value=sprout_dir)
+        mocker.patch("sprout.commands.create.branch_exists", return_value=False)
+
+        # Mock git ls-files to return empty list (no .env.example files)
+        mock_run = mocker.patch("sprout.commands.create.run_command")
+        mock_run.return_value = Mock(stdout="", returncode=0)
+
+        result = runner.invoke(app, ["create", "feature-branch", "--path"])
+
+        assert result.exit_code == 0
+        # In path mode, only the path should be printed to stdout
+        assert result.stdout.strip() == str(sprout_dir / "feature-branch")
+
 
 class TestLsCommand:
     """Test sprout ls command."""

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/tests/test_integration.py

@@ -198,6 +198,47 @@ class TestIntegrationWorkflow:
         worktree_path = git_repo / ".sprout" / "existing-branch"
         assert worktree_path.exists()
 
+    def test_branch_placeholder(self, git_repo, monkeypatch):
+        """Test that {{ branch() }} placeholder is replaced with branch name."""
+        git_repo, default_branch = git_repo
+        monkeypatch.chdir(git_repo)
+        monkeypatch.setenv("API_KEY", "test_key")
+
+        # Create .env.example with branch() placeholder
+        env_example = git_repo / ".env.example"
+        env_example.write_text(
+            "# Branch-specific configuration\n"
+            "BRANCH_NAME={{ branch() }}\n"
+            "SERVICE_NAME=myapp-{{ branch() }}\n"
+            "API_KEY={{ API_KEY }}\n"
+            "PORT={{ auto_port() }}\n"
+            "COMPOSE_VAR=${BRANCH_NAME}\n"
+        )
+
+        # Add to git
+        subprocess.run(["git", "add", ".env.example"], cwd=git_repo, check=True)
+        subprocess.run(
+            ["git", "commit", "-m", "Add .env.example with branch placeholder"],
+            cwd=git_repo,
+            check=True,
+        )
+
+        # Create worktree
+        branch_name = "feature-auth"
+        result = runner.invoke(app, ["create", branch_name])
+        assert result.exit_code == 0
+
+        # Verify .env was created with correct branch name substitution
+        env_file = git_repo / ".sprout" / branch_name / ".env"
+        env_content = env_file.read_text()
+
+        # Check branch name substitutions
+        assert f"BRANCH_NAME={branch_name}" in env_content
+        assert f"SERVICE_NAME=myapp-{branch_name}" in env_content
+        assert "API_KEY=test_key" in env_content
+        assert "PORT=" in env_content  # Should have a port number
+        assert "COMPOSE_VAR=${BRANCH_NAME}" in env_content  # Docker syntax preserved
+
     def test_error_cases(self, git_repo, monkeypatch, tmp_path):
         """Test various error conditions."""
         git_repo, default_branch = git_repo
@@ -223,11 +264,12 @@ class TestIntegrationWorkflow:
         result = runner.invoke(app, ["path", "nonexistent"])
         assert result.exit_code == 1
 
-        # Remove .env.example and try to create
+        # Remove .env.example and try to create (should succeed now)
         (git_repo / ".env.example").unlink()
         result = runner.invoke(app, ["create", "another-branch"])
-        assert result.exit_code == 1
-        assert "No .env.example files found" in result.stdout
+        assert result.exit_code == 0
+        assert "Warning: No .env.example files found" in result.stdout
+        assert "Workspace 'another-branch' created successfully!" in result.stdout
 
         # Test outside git repo using a separate temp directory
         import tempfile

{sprout_cli-0.4.0 → sprout_cli-0.6.0}/tests/test_utils.py

@@ -179,6 +179,47 @@ class TestEnvTemplateParser:
         result = parse_env_template(template)
         assert result == "COMPOSE_VAR=${COMPOSE_VAR:-default}"
 
+    def test_parse_env_template_branch_placeholder(self, tmp_path):
+        """Test parsing {{ branch() }} placeholders."""
+        template = tmp_path / ".env.example"
+        template.write_text("BRANCH_NAME={{ branch() }}\nFEATURE={{ branch() }}_feature")
+
+        result = parse_env_template(template, branch_name="feature-auth")
+        assert result == "BRANCH_NAME=feature-auth\nFEATURE=feature-auth_feature"
+
+    def test_parse_env_template_branch_placeholder_none(self, tmp_path):
+        """Test {{ branch() }} placeholder when branch_name is None."""
+        template = tmp_path / ".env.example"
+        template.write_text("BRANCH={{ branch() }}")
+
+        # When branch_name is None, placeholder should remain unchanged
+        result = parse_env_template(template, branch_name=None)
+        assert result == "BRANCH={{ branch() }}"
+
+    def test_parse_env_template_mixed_placeholders(self, tmp_path, mocker):
+        """Test parsing mixed placeholders in one template."""
+        mocker.patch("sprout.utils.find_available_port", return_value=8080)
+        mocker.patch.dict(os.environ, {"API_KEY": "secret"})
+        mocker.patch("sprout.utils.console.input", return_value="password123")
+
+        template = tmp_path / ".env.example"
+        template.write_text(
+            "API_KEY={{ API_KEY }}\n"
+            "PORT={{ auto_port() }}\n"
+            "BRANCH={{ branch() }}\n"
+            "DB_PASS={{ DB_PASS }}\n"
+            "COMPOSE_VAR=${COMPOSE_VAR}"
+        )
+
+        result = parse_env_template(template, branch_name="feature-xyz")
+        assert result == (
+            "API_KEY=secret\n"
+            "PORT=8080\n"
+            "BRANCH=feature-xyz\n"
+            "DB_PASS=password123\n"
+            "COMPOSE_VAR=${COMPOSE_VAR}"
+        )
+
     def test_parse_env_template_file_not_found(self, tmp_path):
         """Test error when template file doesn't exist."""
         template = tmp_path / "nonexistent.env"