sprout-cli 0.2.0__tar.gz

sprout_cli-0.2.0/.gitignore

@@ -0,0 +1,145 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# uv
+.venv/
+uv.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# sprout specific
+.sprout/
+tmp/
+
+# Claude Code specific
+.claude/settings.local.json

sprout_cli-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 SecDevLab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sprout_cli-0.2.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: sprout-cli
+Version: 0.2.0
+Summary: CLI tool to automate git worktree and Docker Compose development workflows
+Author: SecDevLab Inc.
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.11
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: types-setuptools>=68.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sprout
+
+A CLI tool to automate git worktree and Docker Compose development workflows.
+
+## Features
+
+- 🌱 Create isolated development environments using git worktrees
+- 🔧 Automatic `.env` file generation from templates
+- 🚢 Smart port allocation to avoid conflicts
+- 📁 Centralized worktree management in `.sprout/` directory
+- 🎨 Beautiful CLI interface with colors and tables
+
+## Installation
+
+```bash
+pip install sprout
+```
+
+For development:
+```bash
+# Clone the repository
+git clone https://github.com/SecDev-Lab/sprout.git
+cd sprout
+
+# Install in development mode
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+1. Create a `.env.example` template in your project root:
+```env
+# API Configuration
+API_KEY={{ API_KEY }}
+API_PORT={{ auto_port() }}
+
+# Database Configuration  
+DB_HOST=localhost
+DB_PORT={{ auto_port() }}
+
+# Example: Docker Compose variables (preserved as-is)
+# sprout will NOT process ${...} syntax - it's passed through unchanged
+# DB_NAME=${DB_NAME}
+```
+
+2. Create a new development environment:
+```bash
+sprout create feature-branch
+```
+
+3. Navigate to your new environment:
+```bash
+cd $(sprout path feature-branch)
+```
+
+4. Start your services:
+```bash
+docker compose up -d
+```
+
+## Commands
+
+### `sprout create <branch-name>`
+Create a new development environment with automated setup.
+
+### `sprout ls`
+List all managed development environments with their status.
+
+### `sprout rm <branch-name>`
+Remove a development environment (with confirmation prompts).
+
+### `sprout path <branch-name>`
+Get the filesystem path of a development environment.
+
+### `sprout --version`
+Show the version of sprout.
+
+## Template Syntax
+
+sprout supports two 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`)
+   - **Then**: If not found in environment, prompts for user input
+   - Example: `{{ API_KEY }}` will use `$API_KEY` if set, otherwise asks you to enter it
+
+2. **Auto Port Assignment**: `{{ auto_port() }}`
+   - Automatically assigns available ports
+   - Avoids conflicts with other sprout environments
+   - Checks system port availability
+
+3. **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`
+
+### Environment Variable Resolution Example
+
+```bash
+# Set environment variable
+export API_KEY="my-secret-key"
+
+# Create sprout environment - API_KEY will be automatically used
+sprout create feature-branch
+# → API_KEY in .env will be set to "my-secret-key" without prompting
+
+# For unset variables, sprout will prompt
+sprout create another-branch
+# → Enter a value for 'DATABASE_URL': [user input required]
+```
+
+## Documentation
+
+- [Architecture Overview](docs/sprout-cli/overview.md) - Design philosophy, architecture, and implementation details
+- [Detailed Usage Guide](docs/sprout-cli/usage.md) - Comprehensive usage examples and troubleshooting
+
+## Development
+
+### Setup
+```bash
+# Install development dependencies
+make setup
+```
+
+### Testing
+```bash
+# Run tests
+make test
+
+# Run tests with coverage
+make test-cov
+```
+
+### Code Quality
+```bash
+# Run linter
+make lint
+
+# Format code
+make format
+
+# Run type checking
+make typecheck
+```
+
+## Requirements
+
+- Python 3.11+
+- Git
+- Docker Compose (optional, for Docker-based workflows)
+
+## License
+
+See LICENSE file.

sprout_cli-0.2.0/README.md

@@ -0,0 +1,154 @@
+# sprout
+
+A CLI tool to automate git worktree and Docker Compose development workflows.
+
+## Features
+
+- 🌱 Create isolated development environments using git worktrees
+- 🔧 Automatic `.env` file generation from templates
+- 🚢 Smart port allocation to avoid conflicts
+- 📁 Centralized worktree management in `.sprout/` directory
+- 🎨 Beautiful CLI interface with colors and tables
+
+## Installation
+
+```bash
+pip install sprout
+```
+
+For development:
+```bash
+# Clone the repository
+git clone https://github.com/SecDev-Lab/sprout.git
+cd sprout
+
+# Install in development mode
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+1. Create a `.env.example` template in your project root:
+```env
+# API Configuration
+API_KEY={{ API_KEY }}
+API_PORT={{ auto_port() }}
+
+# Database Configuration  
+DB_HOST=localhost
+DB_PORT={{ auto_port() }}
+
+# Example: Docker Compose variables (preserved as-is)
+# sprout will NOT process ${...} syntax - it's passed through unchanged
+# DB_NAME=${DB_NAME}
+```
+
+2. Create a new development environment:
+```bash
+sprout create feature-branch
+```
+
+3. Navigate to your new environment:
+```bash
+cd $(sprout path feature-branch)
+```
+
+4. Start your services:
+```bash
+docker compose up -d
+```
+
+## Commands
+
+### `sprout create <branch-name>`
+Create a new development environment with automated setup.
+
+### `sprout ls`
+List all managed development environments with their status.
+
+### `sprout rm <branch-name>`
+Remove a development environment (with confirmation prompts).
+
+### `sprout path <branch-name>`
+Get the filesystem path of a development environment.
+
+### `sprout --version`
+Show the version of sprout.
+
+## Template Syntax
+
+sprout supports two 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`)
+   - **Then**: If not found in environment, prompts for user input
+   - Example: `{{ API_KEY }}` will use `$API_KEY` if set, otherwise asks you to enter it
+
+2. **Auto Port Assignment**: `{{ auto_port() }}`
+   - Automatically assigns available ports
+   - Avoids conflicts with other sprout environments
+   - Checks system port availability
+
+3. **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`
+
+### Environment Variable Resolution Example
+
+```bash
+# Set environment variable
+export API_KEY="my-secret-key"
+
+# Create sprout environment - API_KEY will be automatically used
+sprout create feature-branch
+# → API_KEY in .env will be set to "my-secret-key" without prompting
+
+# For unset variables, sprout will prompt
+sprout create another-branch
+# → Enter a value for 'DATABASE_URL': [user input required]
+```
+
+## Documentation
+
+- [Architecture Overview](docs/sprout-cli/overview.md) - Design philosophy, architecture, and implementation details
+- [Detailed Usage Guide](docs/sprout-cli/usage.md) - Comprehensive usage examples and troubleshooting
+
+## Development
+
+### Setup
+```bash
+# Install development dependencies
+make setup
+```
+
+### Testing
+```bash
+# Run tests
+make test
+
+# Run tests with coverage
+make test-cov
+```
+
+### Code Quality
+```bash
+# Run linter
+make lint
+
+# Format code
+make format
+
+# Run type checking
+make typecheck
+```
+
+## Requirements
+
+- Python 3.11+
+- Git
+- Docker Compose (optional, for Docker-based workflows)
+
+## License
+
+See LICENSE file.

sprout_cli-0.2.0/pyproject.toml

@@ -0,0 +1,125 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sprout-cli"
+dynamic = ["version"]
+description = "CLI tool to automate git worktree and Docker Compose development workflows"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {text = "MIT"}
+authors = [
+    {name = "SecDevLab Inc."},
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Version Control :: Git",
+    "Topic :: Software Development :: Build Tools",
+]
+dependencies = [
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "pytest-mock>=3.0",
+    "ruff>=0.1.0",
+    "mypy>=1.5.0",
+    "types-setuptools>=68.0",
+]
+
+[project.scripts]
+sprout = "sprout.__main__:main"
+
+[tool.hatch.version]
+path = "src/sprout/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sprout"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+    "/pyproject.toml",
+]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+ignore = [
+    "UP040",  # TypeAlias annotations - not compatible with typer
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "S103"]
+"src/sprout/cli.py" = ["B008"]  # Typer uses function calls in defaults
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+addopts = [
+    "--strict-markers",
+    "--verbose",
+]
+
+[tool.coverage.run]
+source_pkgs = ["sprout"]
+branch = true
+parallel = true
+omit = [
+    "src/sprout/__main__.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "raise NotImplementedError",
+]
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+strict = true
+ignore_missing_imports = true
+
+# Per-module options
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+disallow_incomplete_defs = false

sprout_cli-0.2.0/src/sprout/__init__.py

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

sprout_cli-0.2.0/src/sprout/__main__.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+"""Entry point for the sprout CLI."""
+
+from sprout.cli import app
+
+
+def main() -> None:
+    """Run the sprout CLI application."""
+    app()
+
+
+if __name__ == "__main__":
+    main()