Metadata-Version: 2.4
Name: ready-to-work
Version: 0.0.0a2
Summary: Architect loop framework for AI-driven development
Project-URL: Homepage, https://github.com/joey-lou/ready-to-work
Project-URL: Documentation, https://github.com/joey-lou/ready-to-work#readme
Project-URL: Repository, https://github.com/joey-lou/ready-to-work
Project-URL: Issues, https://github.com/joey-lou/ready-to-work/issues
Author-email: Joey Lou <joey99lou@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Joey Lou
        
        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.
License-File: LICENSE
Keywords: agent,ai,automation,cursor,development,llm
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.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Code Generators
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# ready-to-work (rtw)

[![PyPI version](https://img.shields.io/pypi/v/ready-to-work.svg)](https://pypi.org/project/ready-to-work/)
[![Python versions](https://img.shields.io/pypi/pyversions/ready-to-work.svg)](https://pypi.org/project/ready-to-work/)
[![License](https://img.shields.io/pypi/l/ready-to-work.svg)](https://github.com/joey-lou/ready-to-work/blob/main/LICENSE)
[![CI](https://github.com/joey-lou/ready-to-work/actions/workflows/ci.yml/badge.svg)](https://github.com/joey-lou/ready-to-work/actions/workflows/ci.yml)

Plan → Execute → Review loop for AI-driven development. Unlike simple chat, rtw orchestrates an **agentic loop** where the AI actually executes code changes step-by-step.

## Key Features

- **Step-by-step execution**: Each plan step runs individually with its own timeout, enabling early abort on failures and better error attribution
- **Swappable backends**: Cursor Agent (default), Codex CLI, Claude Code (stubs ready)
- **Persistent state**: Interrupt and resume runs, inspect intermediate results in `.rtw/runs/`
- **Lessons learned**: Cumulative memory across iterations helps the agent avoid repeating mistakes

## Installation

```bash
pip install ready-to-work
```

Or with [uv](https://docs.astral.sh/uv/):

```bash
uv tool install ready-to-work
```

**Prerequisites:** [Cursor Agent CLI](https://cursor.com/docs/cli) (authenticated), Python 3.11+.

## Usage

```bash
rtw run task.md                      # Run architect loop
rtw run task.md --max-iter 5         # Limit iterations
rtw run task.md --model sonnet-4.6   # Override model
rtw run task.md --backend codex      # Use different agent backend
rtw list                             # List runs
rtw resume                           # Resume latest run
```

### Agent Backends

| Backend  | CLI               | Status                          |
| -------- | ----------------- | ------------------------------- |
| `cursor` | `cursor-agent -p` | ✅ Implemented                  |
| `codex`  | `codex`           | 🔧 Stub (contributions welcome) |
| `claude` | `claude`          | 🔧 Stub (contributions welcome) |

## Development

```bash
git clone https://github.com/joey-lou/ready-to-work.git
cd ready-to-work
uv sync
uv run pre-commit install
```

Run tests and linting:

```bash
uv run pytest
uv run ruff check . && uv run ruff format .
```

## Releasing

Version is derived from git tags via [hatch-vcs](https://github.com/ofek/hatch-vcs). To release:

```bash
git tag v0.3.0 && git push --tags
```

This triggers the [release workflow](.github/workflows/release.yml), which publishes to [PyPI](https://pypi.org/project/ready-to-work/) and creates a [GitHub Release](https://github.com/joey-lou/ready-to-work/releases).

## License

[MIT](LICENSE)
