spawnio 1.0.6__tar.gz → 1.0.8__tar.gz

spawnio-1.0.8/.coderabbit.yaml

@@ -0,0 +1,105 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+# CodeRabbit configuration for spawnio
+# https://docs.coderabbit.ai/reference/configuration
+#
+# NOTE FOR MAINTAINERS: This file configures CodeRabbit's behavior once the
+# GitHub App is installed. To activate it, install CodeRabbit at:
+#   https://github.com/apps/coderabbitai
+# The YAML alone does nothing without the App being installed on the repo.
+
+language: "en-US"
+
+reviews:
+  profile: "chill"
+
+  # Auto-review settings
+  auto_review:
+    enabled: true
+    incremental: true
+    drafts: false
+    base_branches: []           # only the default branch (main)
+
+  # Walkthrough + summary in the PR comment
+  high_level_summary: true
+  high_level_summary_in_walkthrough: true
+  changed_files_summary: true
+  sequence_diagrams: true
+
+  # Do not auto-approve or request auto-merge — those are human decisions
+  # (auto_approve_reviews defaults to false — listed here for explicitness)
+  # auto_approve_reviews: false   # already the default; not setting to avoid confusion
+
+  # Restrict review to the files this project actually owns
+  path_filters:
+    - "src/spawn/**"
+    - "tests/**"
+    - "!**/__pycache__/**"
+    - "!**/*.pyc"
+    - "!dist/**"
+    - "!.venv/**"
+    - "!uv.lock"
+
+  # Path-specific review instructions
+  path_instructions:
+    - path: "src/spawn/templates/**"
+      instructions: >
+        Check for cross-platform path handling. This project targets Windows
+        as a first-class platform: prefer pathlib.Path over os.path string
+        operations, avoid hardcoded forward-slashes in file paths, and flag
+        any str() coercions of Path objects that could break on Windows.
+
+    - path: "src/spawn/github/**"
+      instructions: >
+        Flag input validation and URL parsing issues. GitHub URLs must be
+        validated before use — check that repository URLs are validated
+        against the existing validators.py patterns, that user-supplied
+        strings are never interpolated directly into subprocess commands, and
+        that GitHubPublishError is raised (not a raw exception) on all failure
+        paths.
+
+    - path: "src/spawn/cli/app.py"
+      instructions: >
+        Flag function length and complexity. The create() function is known to
+        be monolithic — flag any new logic added to its body that should
+        instead live in a helper or in noninteractive.py. Prefer raising
+        SpawnError over inline console.print()+return patterns for new error
+        paths.
+
+    - path: "src/spawn/cli/**"
+      instructions: >
+        Verify that every new prompt uses _select() or _multiselect() from
+        prompts.py (questionary-based, arrow-key driven) rather than
+        typer.prompt() with a numeric choice map. typer.prompt() is only
+        acceptable for free-text inputs (project name, dependency list, etc.).
+
+    - path: "tests/**"
+      instructions: >
+        Confirm that questionary.select and questionary.checkbox are mocked
+        via patch('spawn.cli.prompts.questionary.select') and
+        patch('spawn.cli.prompts.questionary.checkbox'), not via numeric
+        typer.prompt side effects. New generator tests should use the
+        _mock_uv_and_install() context manager pattern already established
+        in the file.
+
+  # Enable the built-in Ruff tool integration (already in dev deps).
+  # NOTE: must live under reviews.tools, not top-level tools — a top-level
+  # `tools:` key is not part of the schema and is silently ignored.
+  tools:
+    ruff:
+      enabled: true
+    # Disable linters irrelevant to this pure-Python project
+    shellcheck:
+      enabled: false
+    biome:
+      enabled: false
+    hadolint:
+      enabled: false       # project has no Dockerfiles in src/
+    phpstan:
+      enabled: false
+    golangci-lint:
+      enabled: false
+    swiftlint:
+      enabled: false
+
+chat:
+  auto_reply: true

spawnio-1.0.8/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,77 @@
+name: Bug report
+description: Something isn't working as expected
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before filing, check the [open issues](https://github.com/Abhiix0/Spawn/issues)
+        and [changelog](https://github.com/Abhiix0/Spawn/blob/main/docs/changelog.md)
+        to see if this is already known.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: A clear description of the bug.
+      placeholder: "When I run `spawn create`, it …"
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Steps to reproduce
+      description: Minimal steps to trigger the bug.
+      placeholder: |
+        1. Run `spawn create`
+        2. Choose template …
+        3. See error …
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What should have happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: What actually happened? Paste any error output or traceback here.
+      render: shell
+    validations:
+      required: true
+
+  - type: input
+    id: spawn_version
+    attributes:
+      label: Spawn version
+      description: Output of `spawn version`
+      placeholder: "Spawn v1.0.7"
+    validations:
+      required: true
+
+  - type: input
+    id: python_version
+    attributes:
+      label: Python version
+      description: Output of `python --version`
+      placeholder: "Python 3.12.3"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      options:
+        - Windows
+        - macOS
+        - Linux
+    validations:
+      required: true

spawnio-1.0.8/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Discussions
+    url: https://github.com/Abhiix0/Spawn/discussions
+    about: Ask questions, share ideas, or discuss spawnio without filing a formal issue.

spawnio-1.0.8/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: Feature request
+description: Suggest a new template, command, or improvement
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem / use case
+      description: What are you trying to do that spawnio doesn't support today?
+      placeholder: "I want to scaffold a … project but there's no template for it."
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed solution
+      description: What would you like to see added or changed?
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Any other approaches you've thought about? Fine to leave blank.
+    validations:
+      required: false

spawnio-1.0.8/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+## Description
+
+<!-- What does this PR do? Be specific enough that a reviewer can understand the change without reading the diff first. -->
+
+## Related issue
+
+<!-- If this closes an issue: "Closes #N". If there's no issue, delete this section. -->
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature / new template
+- [ ] Documentation
+- [ ] Refactor / internal cleanup
+- [ ] CI / tooling
+
+## Checklist
+
+- [ ] `uv run pytest` passes locally
+- [ ] `uv run ruff check .` is clean
+- [ ] `uv run ruff format --check .` is clean
+- [ ] New template PRs include both a `test_<slug>_template.py` and `test_<slug>_generator.py`
+- [ ] `tests/test_registry.py` slug count updated (if a template was added or removed)
+- [ ] Docs updated if the change affects user-facing behavior (README, docs/, CONTRIBUTING)

spawnio-1.0.8/.github/labeler.yml

@@ -0,0 +1,25 @@
+templates:
+  - changed-files:
+      - any-glob-to-any-file: "src/spawn/templates/**"
+
+core:
+  - changed-files:
+      - any-glob-to-any-file: "src/spawn/core/**"
+
+cli:
+  - changed-files:
+      - any-glob-to-any-file: "src/spawn/cli/**"
+
+docs:
+  - changed-files:
+      - any-glob-to-any-file:
+          - "docs/**"
+          - "README.md"
+
+tests:
+  - changed-files:
+      - any-glob-to-any-file: "tests/**"
+
+ci:
+  - changed-files:
+      - any-glob-to-any-file: ".github/**"

{spawnio-1.0.6 → spawnio-1.0.8}/.github/workflows/ci.yml

@@ -1,29 +1,29 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-
-      - name: Set up Python
-        run: uv python install 3.12
-
-      - name: Install dependencies
-        run: uv sync --all-groups
-
-      - name: Run tests
-        run: uv run pytest
-
-      - name: Run ruff
-        run: uv run ruff check .
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Run ruff
+        run: uv run ruff check .

spawnio-1.0.8/.github/workflows/pr-check.yml

@@ -0,0 +1,60 @@
+name: PR Check
+
+# Runs on every PR targeting main.
+# ci.yml already runs the plain test + ruff-check pass on both push and PR.
+# This workflow adds what ci.yml does not: coverage reporting, format check,
+# and automatic PR labeling — so there is no duplicate test run.
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches: [main]
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Coverage + format check
+  # ---------------------------------------------------------------------------
+  coverage:
+    name: Coverage & Format
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run tests with coverage
+        run: uv run pytest --cov=src/spawn --cov-report=xml --cov-report=term-missing
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml
+          retention-days: 7
+
+  # ---------------------------------------------------------------------------
+  # Auto-labeling
+  # ---------------------------------------------------------------------------
+  label:
+    name: Label PR
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/labeler@v5
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          configuration-path: .github/labeler.yml

spawnio-1.0.8/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish

spawnio-1.0.8/CONTRIBUTING.md

@@ -0,0 +1,169 @@
+# Contributing to spawnio
+
+Solo-maintained, but PRs are welcome. Here's what you need to know.
+
+---
+
+## Prerequisites
+
+- Python 3.12+ (`uv python install 3.12` if using uv)
+- [uv](https://github.com/astral-sh/uv) installed
+
+---
+
+## Setup
+
+```bash
+git clone https://github.com/Abhiix0/Spawn.git
+cd Spawn
+uv sync --all-groups
+```
+
+---
+
+## Running tests
+
+```bash
+uv run pytest
+```
+
+With coverage:
+
+```bash
+uv run pytest --cov=src/spawn --cov-report=term-missing
+```
+
+---
+
+## Linting and formatting
+
+```bash
+uv run ruff check .
+uv run ruff format .
+```
+
+Both must pass before opening a PR. CI enforces this.
+
+---
+
+## Adding a new template
+
+Templates follow a consistent three-file pattern. MCP Server (`src/spawn/templates/mcp_server/`) is the cleanest minimal example to copy from.
+
+### 1. Create the template package
+
+```
+src/spawn/templates/<your_slug>/
+    __init__.py     # MyTemplate(BaseTemplate) class
+    content.py      # string constants + make_readme() + make_agents_md()
+```
+
+**`content.py`** holds all file content as triple-quoted strings with `{project_name}` placeholders (resolved later via `.format_map(context)`). Export `make_readme()` and `make_agents_md()` as functions that return the formatted string — these are called by `BaseTemplate` machinery automatically.
+
+**`__init__.py`** subclasses `BaseTemplate`:
+
+```python
+class MyTemplate(BaseTemplate):
+    def __init__(self, extras: list[str] | None = None) -> None:
+        self.extras = extras or []
+        super().__init__(
+            name="My Template",
+            folders=["src", "tests"],
+            starter_files=[
+                ("src/__init__.py", INIT_CONTENT),
+                ("src/main.py",     MAIN_CONTENT),
+                (".env.example",    ENV_CONTENT),
+            ],
+            next_steps=["cd {project_name}", "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 = ["some-package"]
+        if "pytest" in self.extras:
+            base.append("pytest")
+        return base
+
+    def post_install(self, project_path: Path) -> None:
+        # Write pyproject.toml sections, CI workflows, etc. as needed.
+        pass
+```
+
+If your template needs framework or provider selection, look at `ChatbotTemplate` or `AgentTemplate` — those accept `framework` and `provider` constructor args and use `get_supported_providers()` to filter the provider list per framework.
+
+### 2. Register in `src/spawn/core/registry.py`
+
+Add an import and a `TemplateMetadata` entry to `TEMPLATES`:
+
+```python
+from spawn.templates.my_template import MyTemplate
+
+TEMPLATES = {
+    # ... existing entries ...
+    "my-slug": TemplateMetadata(
+        slug="my-slug",
+        display_name="My Template",
+        description="One-line description shown in spawn doctor output",
+        template_class=MyTemplate,
+        available_extras=["ruff", "pytest", "github-actions"],
+        # available_frameworks, available_providers, available_cli_types,
+        # available_data_types — only set the fields your template uses.
+    ),
+}
+```
+
+`instantiate_template()` inspects the constructor signature and forwards only the fields the class accepts, so no changes to that function are needed.
+
+### 3. Write tests
+
+Add two test files mirroring the existing pattern:
+
+| File | What to test |
+|---|---|
+| `tests/test_<slug>_template.py` | Template constants, `get_dependencies()`, `get_readme_content()`, `py_compile` on each Python starter file, no unescaped braces |
+| `tests/test_<slug>_generator.py` | `ProjectGenerator().generate()` with mocked uv/git/install, directory structure, README content, `.spawn/meta.json` fields |
+
+See `tests/test_mcp_server_template.py` and `tests/test_mcp_server_generator.py` for the exact mock patterns (`_mock_uv_and_install()` context manager, `_cfg()` helper, `patch.object(MyTemplate, "post_install")`).
+
+Also update `tests/test_registry.py`: increment the `len(slugs) == N` assertion and add `assert "my-slug" in slugs`.
+
+---
+
+## Branch and commit conventions
+
+The git log uses a lightweight conventional-commits style — prefix commits with `feat:`, `fix:`, `docs:`, or `chore:` and use the imperative mood in the subject line:
+
+```
+feat: add <slug> template
+fix: handle edge case in parse_structure
+docs: update CONTRIBUTING.md
+chore: bump version to 1.0.8
+```
+
+Branch off `main`, use a short descriptive name (`feat/my-template`, `fix/windows-path`, etc.).
+
+---
+
+## PR expectations
+
+- All existing tests must pass (`uv run pytest`).
+- New templates require both a `_template` and a `_generator` test file.
+- `uv run ruff check .` and `uv run ruff format --check .` must be clean.
+- CI (`.github/workflows/ci.yml`) must be green.
+- Keep PRs focused — one template or fix per PR.
+
+---
+
+## Reporting issues / asking questions
+
+GitHub Issues are currently **restricted** on this repo. To reach the maintainer:
+
+- Open a [GitHub Discussion](https://github.com/Abhiix0/Spawn/discussions) if Discussions are enabled.
+- Otherwise, leave a comment on an existing PR or tag `@Abhiix0` in your PR description.
+
+If you hit a bug that's blocking you, a PR with a failing test that reproduces it is a faster path to a fix than waiting for issues to be opened.

{spawnio-1.0.6 → spawnio-1.0.8}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Abhiix0
-
-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.
+MIT License
+
+Copyright (c) 2026 Abhiix0
+
+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.