spawnio 1.0.5__py3-none-any.whl

spawn/templates/backend_api/content.py

@@ -0,0 +1,509 @@
+MAIN_CONTENT = """\
+from fastapi import FastAPI
+
+from app.core.config import settings
+from app.api.routes.health import router as health_router
+
+app = FastAPI(title=settings.APP_NAME)
+
+app.include_router(health_router)
+"""
+
+HEALTH_ROUTER_CONTENT = """\
+from fastapi import APIRouter
+
+router = APIRouter()
+
+
+@router.get("/")
+def health_check():
+    return {{"status": "running"}}
+"""
+
+CONFIG_CONTENT = """\
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(env_file=".env")
+
+    APP_NAME: str = "{project_name}"
+    DEBUG: bool = False
+
+
+settings = Settings()
+"""
+
+TEST_HEALTH_CONTENT = """\
+from fastapi.testclient import TestClient
+
+from app.main import app
+
+client = TestClient(app)
+
+
+def test_health_check():
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.json() == {{"status": "running"}}
+"""
+
+ENV_EXAMPLE_CONTENT = """\
+APP_NAME={project_name}
+DEBUG=True
+"""
+
+BACKEND_API_README_CONTENT = """\
+# {project_name}
+
+Generated with [Spawn](https://github.com/your-org/spawn).
+
+## Getting Started
+
+Install dependencies and start the development server:
+
+```bash
+uv run uvicorn app.main:app --reload
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Endpoints
+
+| Method | Path | Description  |
+|--------|------|--------------|
+| GET    | /    | Health check |
+
+## Project Structure
+
+```
+{project_name}/
+├── app/
+│   ├── api/
+│   │   └── routes/
+│   │       └── health.py   # Health check route
+│   ├── core/
+│   │   └── config.py       # App settings (pydantic-settings)
+│   ├── models/             # SQLAlchemy / domain models
+│   ├── schemas/            # Pydantic request/response schemas
+│   ├── services/           # Business logic
+│   └── main.py             # FastAPI app entry point
+├── tests/
+│   └── test_health.py
+├── .env.example
+└── README.md
+```
+"""
+
+BACKEND_API_AGENTS_MD_CONTENT = """\
+# {project_name}
+
+Backend API built with FastAPI.
+
+## Run Command
+
+```bash
+uv run uvicorn app.main:app --reload
+```
+"""
+
+INIT_CONTENT = ""
+
+
+# ---------------------------------------------------------------------------
+# Flask
+# ---------------------------------------------------------------------------
+
+FLASK_APP_INIT_CONTENT = """\
+from flask import Flask
+from app.config import Config
+
+
+def create_app() -> Flask:
+    app = Flask(__name__)
+    app.config.from_object(Config)
+
+    from app.routes.health import health_bp
+    app.register_blueprint(health_bp)
+
+    return app
+"""
+
+FLASK_CONFIG_CONTENT = """\
+import os
+
+
+class Config:
+    APP_NAME: str = os.getenv("APP_NAME", "{project_name}")
+    DEBUG: bool = os.getenv("DEBUG", "True").lower() == "true"
+"""
+
+FLASK_HEALTH_CONTENT = """\
+from flask import Blueprint, jsonify
+
+health_bp = Blueprint("health", __name__)
+
+
+@health_bp.route("/")
+def health_check():
+    return jsonify({{"status": "running"}})
+"""
+
+FLASK_RUN_CONTENT = """\
+from app import create_app
+
+app = create_app()
+
+if __name__ == "__main__":
+    app.run(debug=app.config.get("DEBUG", True))
+"""
+
+FLASK_TEST_HEALTH_CONTENT = """\
+import pytest
+from app import create_app
+
+
+@pytest.fixture
+def client():
+    app = create_app()
+    app.config["TESTING"] = True
+    with app.test_client() as client:
+        yield client
+
+
+def test_health_check(client):
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.get_json() == {{"status": "running"}}
+"""
+
+FLASK_ENV_EXAMPLE_CONTENT = """\
+APP_NAME={project_name}
+DEBUG=True
+"""
+
+FLASK_README_CONTENT = """\
+# {project_name}
+
+Generated with [Spawn](https://github.com/Abhiix0/spawn).
+
+## Getting Started
+
+Install dependencies and start the development server:
+
+```bash
+uv run python run.py
+```
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+## Endpoints
+
+| Method | Path | Description  |
+|--------|------|--------------|
+| GET    | /    | Health check |
+
+## Project Structure
+
+```
+{project_name}/
+├── app/
+│   ├── routes/
+│   │   └── health.py   # Health check blueprint
+│   ├── models/         # Domain models
+│   ├── services/       # Business logic
+│   ├── config.py       # App configuration
+│   └── __init__.py     # App factory
+├── run.py              # Entry point
+├── tests/
+│   └── test_health.py
+├── .env.example
+└── README.md
+```
+"""
+
+FLASK_AGENTS_MD_CONTENT = """\
+# {project_name}
+
+Backend API built with Flask.
+
+## Run Command
+
+```bash
+uv run python run.py
+```
+"""
+
+# ---------------------------------------------------------------------------
+# Django
+# ---------------------------------------------------------------------------
+
+DJANGO_MANAGE_CONTENT = """\
+#!/usr/bin/env python
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+DJANGO_SETTINGS_CONTENT = """\
+from pathlib import Path
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+SECRET_KEY = "django-insecure-change-me-in-production"
+
+DEBUG = True
+
+ALLOWED_HOSTS = ["*"]
+
+INSTALLED_APPS = [
+    "django.contrib.contenttypes",
+    "django.contrib.staticfiles",
+    "apps.health",
+]
+
+MIDDLEWARE = [
+    "django.middleware.common.CommonMiddleware",
+]
+
+ROOT_URLCONF = "config.urls"
+
+WSGI_APPLICATION = "config.wsgi.application"
+
+DATABASES = {{}}
+
+STATIC_URL = "/static/"
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+"""
+
+DJANGO_URLS_CONTENT = """\
+from django.urls import path, include
+
+urlpatterns = [
+    path("", include("apps.health.urls")),
+]
+"""
+
+DJANGO_ASGI_CONTENT = """\
+import os
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
+
+application = get_asgi_application()
+"""
+
+DJANGO_WSGI_CONTENT = """\
+import os
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
+
+application = get_wsgi_application()
+"""
+
+DJANGO_HEALTH_VIEWS_CONTENT = """\
+from django.http import JsonResponse
+
+
+def health_check(request):
+    return JsonResponse({{"status": "running"}})
+"""
+
+DJANGO_HEALTH_URLS_CONTENT = """\
+from django.urls import path
+from apps.health.views import health_check
+
+urlpatterns = [
+    path("", health_check, name="health_check"),
+]
+"""
+
+DJANGO_HEALTH_TESTS_CONTENT = """\
+from django.test import TestCase, Client
+
+
+class HealthCheckTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+
+    def test_health_check(self):
+        response = self.client.get("/")
+        self.assertEqual(response.status_code, 200)
+        self.assertJSONEqual(response.content, {{"status": "running"}})
+"""
+
+DJANGO_README_CONTENT = """\
+# {project_name}
+
+Generated with [Spawn](https://github.com/Abhiix0/spawn).
+
+## Getting Started
+
+Install dependencies and start the development server:
+
+```bash
+uv run python manage.py runserver
+```
+
+## Running Tests
+
+```bash
+uv run python manage.py test
+```
+
+## Endpoints
+
+| Method | Path | Description  |
+|--------|------|--------------|
+| GET    | /    | Health check |
+
+## Project Structure
+
+```
+{project_name}/
+├── manage.py
+├── config/
+│   ├── settings.py
+│   ├── urls.py
+│   ├── asgi.py
+│   └── wsgi.py
+├── apps/
+│   └── health/
+│       ├── views.py
+│       ├── urls.py
+│       └── tests.py
+└── README.md
+```
+"""
+
+DJANGO_AGENTS_MD_CONTENT = """\
+# {project_name}
+
+Backend API built with Django.
+
+## Run Command
+
+```bash
+uv run python manage.py runserver
+```
+"""
+
+# ---------------------------------------------------------------------------
+# Docker
+# ---------------------------------------------------------------------------
+
+DOCKERFILE_FASTAPI_CONTENT = """\
+FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY pyproject.toml .
+RUN pip install uv && uv sync
+
+COPY . .
+
+EXPOSE 8000
+
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]
+"""
+
+DOCKERFILE_FLASK_CONTENT = """\
+FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY pyproject.toml .
+RUN pip install uv && uv sync
+
+COPY . .
+
+EXPOSE 5000
+
+CMD ["python", "run.py"]
+"""
+
+DOCKERFILE_DJANGO_CONTENT = """\
+FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY pyproject.toml .
+RUN pip install uv && uv sync
+
+COPY . .
+
+EXPOSE 8000
+
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+"""
+
+DOCKERIGNORE_CONTENT = """\
+.venv
+__pycache__
+*.pyc
+*.pyo
+.env
+.git
+.gitignore
+"""
+
+# ---------------------------------------------------------------------------
+# GitHub Actions
+# ---------------------------------------------------------------------------
+
+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
+"""
+
+GITHUB_ACTIONS_CI_RUFF_STEP = """\
+      - name: Run Ruff
+        run: uv run ruff check .
+"""
+
+GITHUB_ACTIONS_CI_PYTEST_STEP = """\
+      - name: Run Pytest
+        run: uv run pytest
+"""

spawn/templates/base.py

@@ -0,0 +1,58 @@
+from dataclasses import dataclass, field
+from pathlib import Path
+
+
+@dataclass
+class BaseTemplate:
+    name: str
+    folders: list[str]
+    starter_files: list[tuple[str, str]] = field(default_factory=list)
+    next_steps: list[str] = field(default_factory=list)
+    # Each tuple: (relative_path_string, content_template_string)
+
+    def get_dependencies(self) -> list[str]:
+        """Return packages to install after uv init. Subclasses override."""
+        return []
+
+    def post_install(self, project_path: Path) -> None:
+        """Run post-install actions after packages are installed. Subclasses override."""
+        pass
+
+    def get_readme_content(self, context: dict) -> str | None:
+        """
+        Return custom README content for this template, or None to use the
+        shared README. Subclasses override this to provide template-specific
+        README content.
+        """
+        return None
+
+    def get_agents_md_content(self, context: dict) -> str | None:
+        """
+        Return custom AGENTS.md content for this template, or None to use
+        the shared default. Subclasses override this to provide
+        template-specific agent context — framework, provider, or
+        environment-variable details an agent working on this project
+        would need.
+        """
+        return None
+
+    def generate(self, project_path: Path, context: dict) -> None:
+        """
+        Create the template's folder structure and starter files.
+
+        project_path: the already-created root project directory (Path object)
+        context: dict with at minimum {"project_name": str}
+
+        Subclasses may override this in future phases.
+        The default implementation creates folders and writes starter_files.
+        """
+        for folder in self.folders:
+            (project_path / folder).mkdir(parents=True, exist_ok=True)
+
+        for relative_path, content_template in self.starter_files:
+            file_path = project_path / relative_path
+            file_path.parent.mkdir(parents=True, exist_ok=True)
+            file_path.write_text(
+                content_template.format_map(context),
+                encoding="utf-8",
+            )