OSRS Bot Development SDK with game-native structure
Project description
Escape SDK
Python SDK for OSRS bot development via RuneLite bridge.
Requirements
- Python 3.12+
- Linux with inotify support
- RuneLite with Escape plugin
Installation
pip install escape-sdk
Development
git clone https://github.com/OSEscape/escape_sdk.git
cd escape_sdk
uv sync --all-extras
pre-commit install
make test # Run all checks (ruff, basedpyright, skylos, pytest)
make format # Auto-format and fix linting issues
Contributing
We use Conventional Commits 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
escape_sdk-2.2.1.tar.gz
(119.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
escape_sdk-2.2.1-py3-none-any.whl
(148.5 kB
view details)
File details
Details for the file escape_sdk-2.2.1.tar.gz.
File metadata
- Download URL: escape_sdk-2.2.1.tar.gz
- Upload date:
- Size: 119.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
06c86f2dbfd28c9ea4400d882e97e7560d0431460b63b2ca4f8277338b8cb9bd
|
|
| MD5 |
a88e4bf2651c519eaa48dc5e9eddbbf3
|
|
| BLAKE2b-256 |
ef9bab27a6e846bb361557196a162d7f0fc81ad60f881cc4f32544575ba59e5c
|
File details
Details for the file escape_sdk-2.2.1-py3-none-any.whl.
File metadata
- Download URL: escape_sdk-2.2.1-py3-none-any.whl
- Upload date:
- Size: 148.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d93d0a1c2e38172b22034c6a76c5ffee36eec9c77a4fa580f60bbd7f76200bb5
|
|
| MD5 |
57682c1f67ff53c9c332a49d4cb904f9
|
|
| BLAKE2b-256 |
8f8db704b8475557f3c2790c7dbe42fdf6e636d5b4f628536d9ef5ffbba9988e
|
