feat: cli setup project

Author: ruslan-korneev

README.md

@@ -40,7 +40,28 @@ A production-ready FastAPI template with SQLAlchemy, dependency injection, Sentr
 
 ## Quick Start
 
-### 1. Setup Environment
+### Option 1: Interactive Setup (Recommended)
+
+```bash
+git clone <repository-url>
+cd fastapi-template
+
+# Install dependencies including setup tool
+uv venv
+source .venv/bin/activate
+uv sync --all-groups --group setup
+
+# Run interactive setup wizard
+uv run setup-project
+```
+
+The setup wizard will:
+- Configure project name, description, and author
+- Set up database connection
+- Choose CI/CD platform (GitHub Actions, GitLab CI, or none)
+- Update all configuration files automatically
+
+### Option 2: Manual Setup
 
 ```bash
 git clone <repository-url>
@@ -52,7 +73,7 @@ source .venv/bin/activate
 uv sync --all-groups
 ```
 
-### 2. Configure Database
+Configure database:
 
 ```bash
 cp .env.example .env
@@ -65,7 +86,7 @@ Run database migrations:
 uv run alembic upgrade head
 ```
 
-### 3. Start API Server
+### Start API Server
 
 ```bash
 uv run uvicorn main:app --host 0.0.0.0 --port 8000
@@ -328,6 +349,20 @@ docker build -t fastapi-template .
 docker run -p 8000:8000 --env-file .env fastapi-template
 ```
 
+## Removing Setup Tool
+
+After running the setup wizard, you can remove the setup tool:
+
+```bash
+rm -rf setup_project/
+```
+
+Then remove from `pyproject.toml`:
+- The `setup` group from `[dependency-groups]`
+- The `setup-project` line from `[project.scripts]`
+
+Finally, run `uv sync` to update the lock file.
+
 ## License
 
 MIT

pyproject.toml

@@ -44,6 +44,13 @@ dev = [
     "wemake-python-styleguide (>=1.0.0,<2.0.0)",
     "pre-commit>=4.2.0",
 ]
+setup = [
+    "click>=8.1",
+    "rich>=13.0",
+]
+
+[project.scripts]
+setup-project = "setup_project.cli:main"
 
 [project.entry-points."flake8.extension"]
 WPS = "wemake_python_styleguide.checker:Checker"
@@ -101,6 +108,11 @@ external = [ "WPS" ]
   "S603", # do not require `shell=True`
   "S607", # partial executable paths
 ]
+"setup_project/*.py" = [
+  "S603", # subprocess calls are for setup tool
+  "S607", # partial executable paths
+  "FBT001", # click uses boolean positional args
+]
 
 [tool.ruff.lint.flake8-bugbear]
 extend-immutable-calls = [

setup_project/__init__.py

@@ -0,0 +1 @@
+"""FastAPI Template Setup CLI."""

setup_project/cli.py

@@ -0,0 +1,182 @@
+"""Setup CLI for FastAPI template project."""
+
+import subprocess
+from pathlib import Path
+from typing import Literal
+
+import click
+from rich.console import Console
+from rich.panel import Panel
+from rich.prompt import Confirm, IntPrompt, Prompt
+
+from setup_project.config import ProjectConfig
+from setup_project.updaters import apply_all_updates
+
+console = Console()
+
+
+def get_git_config(key: str) -> str | None:
+    """Get git config value."""
+    try:
+        result = subprocess.run(
+            ["git", "config", "--get", key],
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+        if result.returncode == 0:
+            return result.stdout.strip()
+    except FileNotFoundError:
+        pass
+    return None
+
+
+def get_default_project_name() -> str:
+    """Get default project name from current directory."""
+    return Path.cwd().name
+
+
+def prompt_project_config(
+    name: str | None,
+    description: str | None,
+) -> tuple[str, str, str, str]:
+    """Prompt for project configuration."""
+    console.print("[bold]Project Configuration[/bold]")
+
+    project_name = (
+        name
+        if name
+        else Prompt.ask(
+            "  Project name (kebab-case)",
+            default=get_default_project_name(),
+        )
+    )
+
+    project_description = (
+        description
+        if description
+        else Prompt.ask(
+            "  Description",
+            default="Production-ready FastAPI application",
+        )
+    )
+
+    author_name = Prompt.ask(
+        "  Author name",
+        default=get_git_config("user.name") or "Your Name",
+    )
+
+    author_email = Prompt.ask(
+        "  Author email",
+        default=get_git_config("user.email") or "you@example.com",
+    )
+
+    console.print()
+    return project_name, project_description, author_name, author_email
+
+
+def prompt_db_config(project_name: str) -> tuple[str, str, str, str, int]:
+    """Prompt for database configuration."""
+    console.print("[bold]Database Configuration[/bold]")
+
+    default_db_name = ProjectConfig.derive_db_name(project_name)
+
+    db_name = Prompt.ask("  Database name", default=default_db_name)
+    db_user = Prompt.ask("  Username", default="postgres")
+    db_password = Prompt.ask("  Password", password=True, default="postgres")
+    db_host = Prompt.ask("  Host", default="localhost")
+    db_port = IntPrompt.ask("  Port", default=5432)
+
+    console.print()
+    return db_name, db_user, db_password, db_host, db_port
+
+
+def prompt_ci_config(skip_ci: bool) -> tuple[Literal["github", "gitlab", "none"], str | None]:
+    """Prompt for CI/CD configuration."""
+    ci_platform: Literal["github", "gitlab", "none"] = "github"
+    github_repo: str | None = None
+
+    if skip_ci:
+        return ci_platform, github_repo
+
+    console.print("[bold]CI/CD Platform[/bold]")
+    console.print("  [1] GitHub Actions")
+    console.print("  [2] GitLab CI")
+    console.print("  [3] None")
+
+    ci_choice = Prompt.ask("  Select", choices=["1", "2", "3"], default="1")
+    ci_map: dict[str, Literal["github", "gitlab", "none"]] = {
+        "1": "github",
+        "2": "gitlab",
+        "3": "none",
+    }
+    ci_platform = ci_map[ci_choice]
+
+    if ci_platform == "github":
+        github_repo = Prompt.ask("  GitHub repo URL (for badges)", default="")
+        if not github_repo:
+            github_repo = None
+
+    console.print()
+    return ci_platform, github_repo
+
+
+def print_summary(updated_files: list[str], db_name: str) -> None:
+    """Print summary of changes."""
+    for file in updated_files:
+        if file.startswith("Removed"):
+            console.print(f"  [yellow]{file}[/yellow]")
+        else:
+            console.print(f"  [green]{file}[/green]")
+
+    console.print()
+    console.print("[bold green]Done![/bold green] Next steps:")
+    console.print("  1. [cyan]uv sync[/cyan]")
+    console.print(f"  2. Create database: [cyan]{db_name}[/cyan]")
+    console.print("  3. [cyan]make upgrade-db[/cyan]")
+    console.print("  4. [cyan]make[/cyan]")
+    console.print()
+
+
+@click.command()
+@click.option("--name", help="Project name (kebab-case)")
+@click.option("--description", help="Project description")
+@click.option("--skip-ci", is_flag=True, help="Skip CI/CD configuration prompts")
+def main(name: str | None, description: str | None, skip_ci: bool) -> None:
+    """Setup your FastAPI project from template."""
+    console.print()
+    console.print(Panel("[bold blue]FastAPI Template Setup[/bold blue]", expand=False))
+    console.print()
+
+    project_name, project_description, author_name, author_email = prompt_project_config(name, description)
+    db_name, db_user, db_password, db_host, db_port = prompt_db_config(project_name)
+    ci_platform, github_repo = prompt_ci_config(skip_ci)
+
+    if not Confirm.ask("Apply changes?", default=True):
+        console.print("[yellow]Aborted.[/yellow]")
+        raise SystemExit(0)
+
+    console.print()
+
+    config = ProjectConfig(
+        name=project_name,
+        package_name=ProjectConfig.derive_package_name(project_name),
+        description=project_description,
+        author_name=author_name,
+        author_email=author_email,
+        db_name=db_name,
+        db_user=db_user,
+        db_password=db_password,
+        db_host=db_host,
+        db_port=db_port,
+        ci_platform=ci_platform,
+        github_repo=github_repo,
+    )
+
+    console.print("[bold]Applying changes...[/bold]")
+    updated_files = apply_all_updates(config)
+    print_summary(updated_files, db_name)
+
+
+if __name__ == "__main__":
+    main()

setup_project/config.py

@@ -0,0 +1,32 @@
+"""Project configuration dataclass."""
+
+from dataclasses import dataclass
+from typing import Literal
+
+
+@dataclass
+class ProjectConfig:
+    """Configuration collected from user prompts."""
+
+    name: str  # kebab-case project name
+    package_name: str  # snake_case (derived from name)
+    description: str
+    author_name: str
+    author_email: str
+    db_name: str
+    db_user: str
+    db_password: str
+    db_host: str
+    db_port: int
+    ci_platform: Literal["github", "gitlab", "none"]
+    github_repo: str | None = None
+
+    @classmethod
+    def derive_package_name(cls, name: str) -> str:
+        """Convert kebab-case name to snake_case package name."""
+        return name.replace("-", "_")
+
+    @classmethod
+    def derive_db_name(cls, name: str) -> str:
+        """Convert kebab-case name to snake_case database name."""
+        return name.replace("-", "_")