spawnio 1.0.5__py3-none-any.whl

spawn/templates/mcp_server/content.py

@@ -0,0 +1,161 @@
+INIT_CONTENT = ""
+
+SERVER_CONTENT = """\
+\"\"\"MCP server entrypoint for {project_name}.\"\"\"
+
+from mcp.server import MCPServer
+
+mcp = MCPServer("{project_name}")
+
+
+def _add(a: int, b: int) -> int:
+    return a + b
+
+
+@mcp.tool()
+def add(a: int, b: int) -> int:
+    \"\"\"Add two numbers together.\"\"\"
+    return _add(a, b)
+
+
+def _get_server_info() -> str:
+    return "{project_name} MCP server, built with Spawn."
+
+
+@mcp.resource("info://server")
+def server_info() -> str:
+    \"\"\"Return basic information about this MCP server.\"\"\"
+    return _get_server_info()
+
+
+def main() -> None:
+    mcp.run()
+
+
+if __name__ == "__main__":
+    main()
+"""
+
+TEST_CONTENT = """\
+from src.server import _add, _get_server_info
+
+
+def test_add():
+    assert _add(2, 3) == 5
+
+
+def test_add_negative_numbers():
+    assert _add(-1, -1) == -2
+
+
+def test_server_info_returns_nonempty_string():
+    info = _get_server_info()
+    assert isinstance(info, str)
+    assert len(info) > 0
+"""
+
+ENV_CONTENT = """\
+# Environment variables for {project_name}
+# This MCP server has no required environment variables by default.
+# Add any secrets or configuration your tools/resources need here.
+"""
+
+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
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: uv sync
+"""
+
+GITHUB_ACTIONS_CI_RUFF_STEP = """\
+      - name: Lint
+        run: uv run ruff check .
+"""
+
+GITHUB_ACTIONS_CI_PYTEST_STEP = """\
+      - name: Test
+        run: uv run pytest
+"""
+
+
+def make_readme() -> str:
+    return """\
+# {project_name}
+
+An MCP (Model Context Protocol) server, generated with Spawn.
+
+This server exposes one example tool (`add`) and one example resource
+(`info://server`) over the `stdio` transport, ready to connect to any
+MCP client — Claude Desktop, Claude Code, or your own client built on
+the MCP SDK.
+
+## Run it directly
+
+```bash
+uv run python -m src.server
+```
+
+It will wait on stdio for an MCP client to connect — this is normal,
+it's not meant to be run standalone in a terminal for long.
+
+## Connect it to Claude Desktop
+
+Add this to your `claude_desktop_config.json`:
+
+```json
+{{
+  "mcpServers": {{
+    "{project_name}": {{
+      "command": "uv",
+      "args": ["--directory", "/absolute/path/to/{project_name}", "run", "python", "-m", "src.server"]
+    }}
+  }}
+}}
+```
+
+Replace `/absolute/path/to/{project_name}` with this project's actual
+path, then restart Claude Desktop.
+
+## Add your own tools and resources
+
+Open `src/server.py`. Add a new function decorated with `@mcp.tool()`
+for anything you want an MCP client to be able to call, or
+`@mcp.resource("your://uri")` for anything you want it to be able to
+read.
+
+## Tests
+
+```bash
+uv run pytest
+```
+"""
+
+
+def make_agents_md() -> str:
+    return """\
+# {project_name}
+
+An MCP (Model Context Protocol) server built using the `mcp` SDK's `MCPServer` class.
+
+## Adding Tools and Resources
+
+Open `src/server.py`.
+
+- Add a new tool: Decorate a function with `@mcp.tool()` to expose callable tools to MCP clients.
+- Add a new resource: Decorate a function with `@mcp.resource("uri")` to expose readable resources to MCP clients.
+"""

spawn/templates/rag/__init__.py

@@ -0,0 +1,124 @@
+from pathlib import Path
+
+from spawn.templates.base import BaseTemplate
+from spawn.templates.rag.content import (
+    INIT_CONTENT,
+    SAMPLE_KNOWLEDGE_CONTENT,
+    SETTINGS_CONTENT,
+    KNOWLEDGE_INDEX_CONTENT,
+    INGESTION_CONTENT,
+    RETRIEVAL_CONTENT,
+    MAIN_CONTENT,
+    TEST_CONTENT,
+    CONFTEST_CONTENT,
+    ENV_CONTENT,
+    GITHUB_ACTIONS_CI_BASE,
+    GITHUB_ACTIONS_CI_RUFF_STEP,
+    GITHUB_ACTIONS_CI_PYTEST_STEP,
+    make_readme,
+    make_agents_md,
+)
+
+RAG_FOLDERS = [
+    "data",
+    "chroma_db",
+    "src/ingestion",
+    "src/retrieval",
+    "src/knowledge",
+    "src/config",
+    "tests",
+]
+
+
+def _build_files() -> list:
+    return [
+        ("data/sample_knowledge.md",      SAMPLE_KNOWLEDGE_CONTENT),
+        ("src/__init__.py",               INIT_CONTENT),
+        ("src/config/__init__.py",        INIT_CONTENT),
+        ("src/config/settings.py",        SETTINGS_CONTENT),
+        ("src/knowledge/__init__.py",     INIT_CONTENT),
+        ("src/knowledge/index.py",        KNOWLEDGE_INDEX_CONTENT),
+        ("src/ingestion/__init__.py",     INIT_CONTENT),
+        ("src/ingestion/ingest.py",       INGESTION_CONTENT),
+        ("src/retrieval/__init__.py",     INIT_CONTENT),
+        ("src/retrieval/retrieve.py",     RETRIEVAL_CONTENT),
+        ("src/main.py",                   MAIN_CONTENT),
+        ("tests/__init__.py",             INIT_CONTENT),
+        ("tests/conftest.py",             CONFTEST_CONTENT),
+        ("tests/test_rag.py",             TEST_CONTENT),
+        (".env.example",                  ENV_CONTENT),
+    ]
+
+
+class RAGTemplate(BaseTemplate):
+    def __init__(self, extras: list[str] | None = None) -> None:
+        self.extras = extras or []
+
+        super().__init__(
+            name="RAG System",
+            folders=list(RAG_FOLDERS),
+            starter_files=_build_files(),
+            next_steps=[
+                "cd {project_name}",
+                "Rename .env.example to .env and add your OPENAI_API_KEY",
+                "uv run python -m src.main",
+            ],
+        )
+
+    def get_readme_content(self, context: dict) -> str | None:
+        return make_readme().format_map(context)
+
+    def get_agents_md_content(self, context: dict) -> str | None:
+        return make_agents_md().format_map(context)
+
+    def get_dependencies(self) -> list[str]:
+        base = [
+            "llama-index-core",
+            "llama-index-vector-stores-chroma",
+            "llama-index-embeddings-openai",
+            "llama-index-llms-openai",
+            "chromadb",
+            "python-dotenv",
+        ]
+        if "pytest" in self.extras:
+            base.append("pytest")
+        if "ruff" in self.extras:
+            base.append("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]\ntestpaths = [\"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 = GITHUB_ACTIONS_CI_BASE
+            if "ruff" in self.extras:
+                ci += GITHUB_ACTIONS_CI_RUFF_STEP
+            if "pytest" in self.extras:
+                ci += GITHUB_ACTIONS_CI_PYTEST_STEP
+            (workflows_path / "ci.yml").write_text(ci, encoding="utf-8")
+
+        # Write .gitkeep into chroma_db/ so git tracks the directory
+        # but the actual DB files are gitignored
+        gitkeep = project_path / "chroma_db" / ".gitkeep"
+        gitkeep.write_text("", encoding="utf-8")
+
+        gitignore_path = project_path / ".gitignore"
+        current_gitignore = gitignore_path.read_text(encoding="utf-8")
+        rag_ignore_rules = "\n# RAG vector database\nchroma_db/*\n!chroma_db/.gitkeep\n"
+        if "chroma_db/*" not in current_gitignore:
+            gitignore_path.write_text(
+                current_gitignore + rag_ignore_rules, encoding="utf-8"
+            )