Metadata-Version: 2.4
Name: escape-sdk
Version: 2.2.1
Summary: OSRS Bot Development SDK with game-native structure
Author: Escape Team
License-Expression: MIT
Project-URL: Homepage, https://github.com/escape/escape
Project-URL: Repository, https://github.com/escape/escape
Project-URL: Issues, https://github.com/escape/escape/issues
Keywords: osrs,runescape,bot,automation,sdk
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: msgpack>=1.0.0
Requires-Dist: inotify-simple>=1.3.5
Requires-Dist: pyautogui>=0.9.54
Requires-Dist: python-xlib>=0.33
Requires-Dist: Pillow>=10.0.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: loguru>=0.7.0
Requires-Dist: ruff>=0.14.13
Requires-Dist: basedpyright>=1.37.1
Requires-Dist: pytest>=9.0.2
Requires-Dist: pytest-cov>=4.1.0
Requires-Dist: skylos>=3.1.1
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: ruff>=0.8.4; extra == "dev"
Requires-Dist: pre-commit>=3.5.0; extra == "dev"
Requires-Dist: basedpyright>=1.27.0; extra == "dev"

# Escape SDK

Python SDK for OSRS bot development via RuneLite bridge.

## Requirements

- Python 3.12+
- Linux with inotify support
- RuneLite with Escape plugin

## Installation

```bash
pip install escape-sdk
```

## Development

```bash
git clone https://github.com/OSEscape/escape_sdk.git
cd escape_sdk
uv sync --all-extras
pre-commit install
```

```bash
make test      # Run all checks (ruff, basedpyright, skylos, pytest)
make format    # Auto-format and fix linting issues
```

## Contributing

We use [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and changelog.

| Type | Bump | Example |
|------|------|---------|
| `feat` | Minor | `feat(bank): add deposit-all` |
| `fix` | Patch | `fix: resolve crash on empty inventory` |
| `feat!` | Major | `feat!: redesign API` |
| `docs`, `refactor`, `test`, `chore` | — | `chore: update deps` |

Push to `main` triggers automatic release to PyPI.

## License

MIT
