Metadata-Version: 2.4
Name: swe-copilot-agents
Version: 0.1.12
Summary: GitHub Copilot agents for AI-assisted software development
Project-URL: Homepage, https://github.com/khaerulumam42/swe-copilot-agents
Project-URL: Repository, https://github.com/khaerulumam42/swe-copilot-agents
Project-URL: Issues, https://github.com/khaerulumam42/swe-copilot-agents/issues
Author-email: Khaerul Umam <khaerul@example.com>
License: MIT
License-File: LICENSE
Keywords: agents,ai,copilot,development,github
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: black>=24.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Description-Content-Type: text/markdown

# swe-copilot-agents

A collection of GitHub Copilot custom agents for the complete software development lifecycle — from planning through implementation, testing, and documentation.

## Installation

```bash
pip install swe-copilot-agents
```

Then install agents into your project:

```bash
cd /path/to/your/project
swe-copilot-agents
```

This copies 7 `.agent.md` files to `.github/agents/` in your project:

```
✓ rug-orchestrator.agent.md
✓ brainstormer.agent.md
✓ plan-executor.agent.md
✓ plan-reviewer.agent.md
✓ pytest-agent.agent.md
✓ knowledge-graph-agent.agent.md
✓ readme-generator.agent.md
```

## Agents

| Agent | Role |
|-------|------|
| `@rug-orchestrator` | Orchestrates the full dev cycle using the RUG (Repeat Until Good) pattern |
| `@brainstormer` | Asks clarifying questions and writes detailed implementation plans |
| `@plan-executor` | Implements plans by matching your codebase's existing style |
| `@plan-reviewer` | Audits implementation against the plan — evidence-driven |
| `@pytest-agent` | Writes exhaustive pytest suites with expert-level mocking |
| `@knowledge-graph-agent` | Builds a `knowledge-graph.yaml` map of your codebase |
| `@readme-generator` | Generates and updates README from the knowledge graph |

See [docs/AGENTS.md](docs/AGENTS.md) for full details on each agent.

## Usage

Start with the orchestrator for end-to-end workflow:

```
@rug-orchestrator
I want to add a user authentication system with JWT tokens
```

Or invoke agents directly:

```
@brainstormer
I need to add a search feature to my application

@plan-reviewer
Review the implementation against docs/plan/2025-03-02-auth.md
```

## How it works

```
User Request
      ↓
@rug-orchestrator (Pure Delegator)
      │
      ├─ Phase 1: @brainstormer → Plan document
      │           ↓ Human Approval
      ├─ Phase 2: @plan-executor → Implementation (per task)
      ├─ Phase 3: @plan-reviewer → Validate
      │           ├─ FAIL → Retry @plan-executor (up to 3×)
      │           └─ PASS → Continue
      └─ Phase 4: @pytest-agent → Tests (optional)
```

Each task is validated before moving on. Failed tasks are retried up to 3 times, then escalated to the human.

## Testing

The package has a cross-platform test suite covering macOS, Linux, and Windows.

```bash
pip install -e ".[dev]"
pytest tests/ -v
```

CI runs automatically on every push across **3 OSes × 5 Python versions** (3.9 – 3.13):

| | Ubuntu | macOS | Windows |
|---|---|---|---|
| Python 3.9 – 3.13 | ✓ | ✓ | ✓ |

Tests cover:
- `install()` — directory creation, file copying, idempotency, error handling
- Agent file validity — Windows-safe filenames, UTF-8 encoding, required YAML frontmatter
- Cross-platform path safety — pathlib usage, no hardcoded separators

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT — see [LICENSE](LICENSE).
