spawnio 1.0.5__py3-none-any.whl

spawn/templates/cli_application/__init__.py

@@ -0,0 +1,211 @@
+from pathlib import Path
+
+from spawn.templates.base import BaseTemplate
+from spawn.templates.cli_application.content import (
+    INIT_CONTENT,
+    TYPER_MAIN_CONTENT,
+    TYPER_COMMANDS_INIT_CONTENT,
+    TYPER_UTILS_INIT_CONTENT,
+    TYPER_TEST_CONTENT,
+    TYPER_README_CONTENT,
+    CLICK_MAIN_CONTENT,
+    CLICK_TEST_CONTENT,
+    CLICK_README_CONTENT,
+    ARGPARSE_MAIN_CONTENT,
+    ARGPARSE_TEST_CONTENT,
+    ARGPARSE_README_CONTENT,
+    TYPER_INTERACTIVE_MAIN_CONTENT,
+    TYPER_INTERACTIVE_TEST_CONTENT,
+    CLICK_INTERACTIVE_MAIN_CONTENT,
+    CLICK_INTERACTIVE_TEST_CONTENT,
+    ARGPARSE_INTERACTIVE_MAIN_CONTENT,
+    ARGPARSE_INTERACTIVE_TEST_CONTENT,
+    CLI_GITHUB_ACTIONS_CI_BASE,
+    CLI_GITHUB_ACTIONS_CI_RUFF_STEP,
+    CLI_GITHUB_ACTIONS_CI_PYTEST_STEP,
+    TYPER_INTERACTIVE_README_CONTENT,
+    CLICK_INTERACTIVE_README_CONTENT,
+    ARGPARSE_INTERACTIVE_README_CONTENT,
+)
+
+# ---------------------------------------------------------------------------
+# Folder structures
+# ---------------------------------------------------------------------------
+
+UTILITY_FOLDERS = [
+    "src/commands",
+    "src/utils",
+    "tests",
+]
+
+INTERACTIVE_FOLDERS = [
+    "src/commands",
+    "src/prompts",
+    "src/ui",
+    "src/utils",
+    "tests",
+]
+
+# ---------------------------------------------------------------------------
+# Utility starter file lists
+# ---------------------------------------------------------------------------
+
+TYPER_UTILITY_FILES = [
+    ("src/__init__.py", INIT_CONTENT),
+    ("src/commands/__init__.py", TYPER_COMMANDS_INIT_CONTENT),
+    ("src/utils/__init__.py", TYPER_UTILS_INIT_CONTENT),
+    ("src/main.py", TYPER_MAIN_CONTENT),
+    ("tests/__init__.py", INIT_CONTENT),
+    ("tests/test_cli.py", TYPER_TEST_CONTENT),
+]
+
+CLICK_UTILITY_FILES = [
+    ("src/__init__.py", INIT_CONTENT),
+    ("src/commands/__init__.py", INIT_CONTENT),
+    ("src/utils/__init__.py", INIT_CONTENT),
+    ("src/main.py", CLICK_MAIN_CONTENT),
+    ("tests/__init__.py", INIT_CONTENT),
+    ("tests/test_cli.py", CLICK_TEST_CONTENT),
+]
+
+ARGPARSE_UTILITY_FILES = [
+    ("src/__init__.py", INIT_CONTENT),
+    ("src/commands/__init__.py", INIT_CONTENT),
+    ("src/utils/__init__.py", INIT_CONTENT),
+    ("src/main.py", ARGPARSE_MAIN_CONTENT),
+    ("tests/__init__.py", INIT_CONTENT),
+    ("tests/test_cli.py", ARGPARSE_TEST_CONTENT),
+]
+
+# ---------------------------------------------------------------------------
+# Interactive starter file lists
+# ---------------------------------------------------------------------------
+
+TYPER_INTERACTIVE_FILES = [
+    ("src/__init__.py", INIT_CONTENT),
+    ("src/commands/__init__.py", INIT_CONTENT),
+    ("src/prompts/__init__.py", INIT_CONTENT),
+    ("src/ui/__init__.py", INIT_CONTENT),
+    ("src/utils/__init__.py", INIT_CONTENT),
+    ("src/main.py", TYPER_INTERACTIVE_MAIN_CONTENT),
+    ("tests/__init__.py", INIT_CONTENT),
+    ("tests/test_cli.py", TYPER_INTERACTIVE_TEST_CONTENT),
+]
+
+CLICK_INTERACTIVE_FILES = [
+    ("src/__init__.py", INIT_CONTENT),
+    ("src/commands/__init__.py", INIT_CONTENT),
+    ("src/prompts/__init__.py", INIT_CONTENT),
+    ("src/ui/__init__.py", INIT_CONTENT),
+    ("src/utils/__init__.py", INIT_CONTENT),
+    ("src/main.py", CLICK_INTERACTIVE_MAIN_CONTENT),
+    ("tests/__init__.py", INIT_CONTENT),
+    ("tests/test_cli.py", CLICK_INTERACTIVE_TEST_CONTENT),
+]
+
+ARGPARSE_INTERACTIVE_FILES = [
+    ("src/__init__.py", INIT_CONTENT),
+    ("src/commands/__init__.py", INIT_CONTENT),
+    ("src/prompts/__init__.py", INIT_CONTENT),
+    ("src/ui/__init__.py", INIT_CONTENT),
+    ("src/utils/__init__.py", INIT_CONTENT),
+    ("src/main.py", ARGPARSE_INTERACTIVE_MAIN_CONTENT),
+    ("tests/__init__.py", INIT_CONTENT),
+    ("tests/test_cli.py", ARGPARSE_INTERACTIVE_TEST_CONTENT),
+]
+
+
+class CLITemplate(BaseTemplate):
+    def __init__(
+        self,
+        framework: str | None = None,
+        extras: list[str] | None = None,
+        cli_type: str | None = None,
+    ) -> None:
+        self.framework = framework or "typer"
+        self.extras = extras or []
+        self.cli_type = cli_type or "utility"
+
+        is_interactive = self.cli_type == "interactive"
+
+        if self.framework == "click":
+            folders = list(INTERACTIVE_FOLDERS if is_interactive else UTILITY_FOLDERS)
+            starter_files = list(
+                CLICK_INTERACTIVE_FILES if is_interactive else CLICK_UTILITY_FILES
+            )
+        elif self.framework == "argparse":
+            folders = list(INTERACTIVE_FOLDERS if is_interactive else UTILITY_FOLDERS)
+            starter_files = list(
+                ARGPARSE_INTERACTIVE_FILES if is_interactive else ARGPARSE_UTILITY_FILES
+            )
+        else:
+            folders = list(INTERACTIVE_FOLDERS if is_interactive else UTILITY_FOLDERS)
+            starter_files = list(
+                TYPER_INTERACTIVE_FILES if is_interactive else TYPER_UTILITY_FILES
+            )
+
+        super().__init__(
+            name="CLI Application",
+            folders=folders,
+            starter_files=starter_files,
+            next_steps=[
+                "cd {project_name}",
+                "uv run python -m src.main greet"
+                if is_interactive
+                else "uv run python -m src.main hello",
+            ],
+        )
+
+    def get_readme_content(self, context: dict) -> str | None:
+        is_interactive = self.cli_type == "interactive"
+        if self.framework == "click":
+            template = CLICK_INTERACTIVE_README_CONTENT if is_interactive else CLICK_README_CONTENT
+        elif self.framework == "argparse":
+            template = ARGPARSE_INTERACTIVE_README_CONTENT if is_interactive else ARGPARSE_README_CONTENT
+        else:
+            template = TYPER_INTERACTIVE_README_CONTENT if is_interactive else TYPER_README_CONTENT
+        return template.format_map(context)
+
+    def get_dependencies(self) -> list[str]:
+        if self.framework == "click":
+            base: list[str] = ["click"]
+        elif self.framework == "argparse":
+            base = []
+        else:
+            base = ["typer"]
+
+        if "pytest" in self.extras:
+            base = base + ["pytest"]
+        if "ruff" in self.extras:
+            base = base + ["ruff"]
+
+        return base
+
+    def post_install(self, project_path: Path) -> None:
+        pyproject = project_path / "pyproject.toml"
+        current = pyproject.read_text(encoding="utf-8")
+        additions = ""
+
+        if "pytest" in self.extras:
+            additions += (
+                "\n[tool.pytest.ini_options]\n"
+                'testpaths = ["tests"]\n'
+            )
+
+        if "ruff" in self.extras:
+            additions += "\n[tool.ruff]\nline-length = 88\n"
+
+        if additions:
+            pyproject.write_text(current + additions, encoding="utf-8")
+
+        if "github-actions" in self.extras:
+            workflows_path = project_path / ".github" / "workflows"
+            workflows_path.mkdir(parents=True, exist_ok=True)
+            ci_content = CLI_GITHUB_ACTIONS_CI_BASE
+            if "ruff" in self.extras:
+                ci_content += CLI_GITHUB_ACTIONS_CI_RUFF_STEP
+            if "pytest" in self.extras:
+                ci_content += CLI_GITHUB_ACTIONS_CI_PYTEST_STEP
+            (workflows_path / "ci.yml").write_text(
+                ci_content, encoding="utf-8"
+            )

spawn/templates/cli_application/content.py

@@ -0,0 +1,512 @@
+INIT_CONTENT = ""
+
+TYPER_MAIN_CONTENT = """\
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def hello() -> None:
+    \"\"\"Say hello.\"\"\"
+    typer.echo("Hello from {project_name}!")
+
+
+@app.command()
+def version() -> None:
+    \"\"\"Show the version.\"\"\"
+    typer.echo("{project_name} v0.1.0")
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+TYPER_COMMANDS_INIT_CONTENT = ""
+
+TYPER_UTILS_INIT_CONTENT = ""
+
+TYPER_TEST_CONTENT = """\
+from typer.testing import CliRunner
+
+from src.main import app
+
+runner = CliRunner()
+
+
+def test_hello_command() -> None:
+    result = runner.invoke(app, ["hello"])
+    assert result.exit_code == 0
+    assert "Hello" in result.output
+
+
+def test_version_command() -> None:
+    result = runner.invoke(app, ["version"])
+    assert result.exit_code == 0
+"""
+
+TYPER_README_CONTENT = """\
+# {project_name}
+
+A CLI application generated with Spawn.
+
+## Getting Started
+
+```bash
+uv run python -m src.main hello
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Commands
+
+| Command | Description             |
+|---------|-------------------------|
+| hello   | Prints a hello message  |
+| version | Shows the version       |
+
+## Development
+
+```bash
+uv run python -m src.main --help
+```
+"""
+
+# ---------------------------------------------------------------------------
+# Click
+# ---------------------------------------------------------------------------
+
+CLICK_MAIN_CONTENT = """\
+import click
+
+
+@click.group()
+def main() -> None:
+    \"\"\"CLI tool for {project_name}.\"\"\"
+    pass
+
+
+@main.command()
+def hello() -> None:
+    \"\"\"Say hello.\"\"\"
+    click.echo("Hello from {project_name}!")
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+CLICK_TEST_CONTENT = """\
+from click.testing import CliRunner
+
+from src.main import main
+
+runner = CliRunner()
+
+
+def test_hello_command() -> None:
+    result = runner.invoke(main, ["hello"])
+    assert result.exit_code == 0
+    assert "Hello" in result.output
+"""
+
+CLICK_README_CONTENT = """\
+# {project_name}
+
+A CLI application generated with Spawn.
+
+## Getting Started
+
+```bash
+uv run python -m src.main hello
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Commands
+
+| Command | Description             |
+|---------|-------------------------|
+| hello   | Prints a hello message  |
+
+## Development
+
+```bash
+uv run python -m src.main --help
+```
+
+Built with Click
+"""
+
+# ---------------------------------------------------------------------------
+# Argparse
+# ---------------------------------------------------------------------------
+
+ARGPARSE_MAIN_CONTENT = """\
+import argparse
+
+
+def hello(args: argparse.Namespace) -> None:
+    \"\"\"Say hello.\"\"\"
+    print("Hello from {project_name}!")
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        prog="{project_name}",
+        description="{project_name} CLI",
+    )
+
+    subparsers = parser.add_subparsers(dest="command")
+
+    hello_parser = subparsers.add_parser("hello", help="Say hello")
+    hello_parser.set_defaults(func=hello)
+
+    args = parser.parse_args()
+
+    if hasattr(args, "func"):
+        args.func(args)
+    else:
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+ARGPARSE_TEST_CONTENT = """\
+import subprocess
+import sys
+
+
+def test_hello_command() -> None:
+    result = subprocess.run(
+        [sys.executable, "-m", "src.main", "hello"],
+        capture_output=True,
+        text=True,
+    )
+    assert result.returncode == 0
+    assert "Hello" in result.stdout
+"""
+
+ARGPARSE_README_CONTENT = """\
+# {project_name}
+
+A CLI application generated with Spawn.
+
+## Getting Started
+
+```bash
+uv run python -m src.main hello
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Commands
+
+| Command | Description             |
+|---------|-------------------------|
+| hello   | Prints a hello message  |
+
+## Development
+
+```bash
+uv run python -m src.main --help
+```
+
+Built with Python's standard argparse library. No external dependencies required.
+"""
+
+# ---------------------------------------------------------------------------
+# Interactive — Typer
+# ---------------------------------------------------------------------------
+
+TYPER_INTERACTIVE_MAIN_CONTENT = """\
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def greet() -> None:
+    \"\"\"Greet the user interactively.\"\"\"
+    name = typer.prompt("What is your name?")
+    typer.echo(f"Hello, {{name}}! Welcome to {project_name}.")
+
+
+@app.command()
+def version() -> None:
+    \"\"\"Show the version.\"\"\"
+    typer.echo("{project_name} v0.1.0")
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+TYPER_INTERACTIVE_TEST_CONTENT = """\
+from typer.testing import CliRunner
+
+from src.main import app
+
+runner = CliRunner()
+
+
+def test_greet_command() -> None:
+    result = runner.invoke(app, ["greet"], input="Alice\\n")
+    assert result.exit_code == 0
+    assert "Hello, Alice" in result.output
+
+
+def test_version_command() -> None:
+    result = runner.invoke(app, ["version"])
+    assert result.exit_code == 0
+"""
+
+# ---------------------------------------------------------------------------
+# Interactive — Click
+# ---------------------------------------------------------------------------
+
+CLICK_INTERACTIVE_MAIN_CONTENT = """\
+import click
+
+
+@click.group()
+def main() -> None:
+    \"\"\"Interactive CLI for {project_name}.\"\"\"
+    pass
+
+
+@main.command()
+def greet() -> None:
+    \"\"\"Greet the user interactively.\"\"\"
+    name = click.prompt("What is your name?")
+    click.echo(f"Hello, {{name}}! Welcome to {project_name}.")
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+CLICK_INTERACTIVE_TEST_CONTENT = """\
+from click.testing import CliRunner
+
+from src.main import main
+
+runner = CliRunner()
+
+
+def test_greet_command() -> None:
+    result = runner.invoke(main, ["greet"], input="Alice\\n")
+    assert result.exit_code == 0
+    assert "Hello, Alice" in result.output
+"""
+
+# ---------------------------------------------------------------------------
+# Interactive — Argparse
+# ---------------------------------------------------------------------------
+
+ARGPARSE_INTERACTIVE_MAIN_CONTENT = """\
+import argparse
+
+
+def greet(args: argparse.Namespace) -> None:
+    \"\"\"Greet the user interactively.\"\"\"
+    name = input("What is your name? ")
+    print(f"Hello, {{name}}! Welcome to {project_name}.")
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        prog="{project_name}",
+        description="{project_name} interactive CLI",
+    )
+
+    subparsers = parser.add_subparsers(dest="command")
+
+    greet_parser = subparsers.add_parser("greet", help="Greet the user")
+    greet_parser.set_defaults(func=greet)
+
+    args = parser.parse_args()
+
+    if hasattr(args, "func"):
+        args.func(args)
+    else:
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+ARGPARSE_INTERACTIVE_TEST_CONTENT = """\
+import subprocess
+import sys
+
+
+def test_greet_command() -> None:
+    result = subprocess.run(
+        [sys.executable, "-m", "src.main", "greet"],
+        input="Alice\\n",
+        capture_output=True,
+        text=True,
+    )
+    assert result.returncode == 0
+    assert "Hello, Alice" in result.stdout
+"""
+
+# ---------------------------------------------------------------------------
+# GitHub Actions CI
+# ---------------------------------------------------------------------------
+
+CLI_GITHUB_ACTIONS_CI_BASE = """\
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync
+"""
+
+CLI_GITHUB_ACTIONS_CI_RUFF_STEP = """\
+      - name: Run Ruff
+        run: uv run ruff check .
+"""
+
+CLI_GITHUB_ACTIONS_CI_PYTEST_STEP = """\
+      - name: Run Pytest
+        run: uv run pytest
+"""
+
+# ---------------------------------------------------------------------------
+# Interactive READMEs
+# ---------------------------------------------------------------------------
+
+TYPER_INTERACTIVE_README_CONTENT = """\
+# {project_name}
+
+A CLI application generated with Spawn.
+
+## Getting Started
+
+```bash
+uv run python -m src.main greet
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Commands
+
+| Command | Description                    |
+|---------|--------------------------------|
+| greet   | Greets the user interactively  |
+| version | Shows the version              |
+
+## Development
+
+```bash
+uv run python -m src.main --help
+```
+"""
+
+CLICK_INTERACTIVE_README_CONTENT = """\
+# {project_name}
+
+A CLI application generated with Spawn.
+
+## Getting Started
+
+```bash
+uv run python -m src.main greet
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Commands
+
+| Command | Description                    |
+|---------|--------------------------------|
+| greet   | Greets the user interactively  |
+
+## Development
+
+```bash
+uv run python -m src.main --help
+```
+
+Built with Click
+"""
+
+ARGPARSE_INTERACTIVE_README_CONTENT = """\
+# {project_name}
+
+A CLI application generated with Spawn.
+
+## Getting Started
+
+```bash
+uv run python -m src.main greet
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Commands
+
+| Command | Description                    |
+|---------|--------------------------------|
+| greet   | Greets the user interactively  |
+
+## Development
+
+```bash
+uv run python -m src.main --help
+```
+
+Built with Python's standard argparse library. No external dependencies required.
+"""