Skip to main content

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

Metadata

Release files for escape-sdk 2.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for escape-sdk 2.2.1
File Size Uploaded
escape_sdk-2.2.1.tar.gz 119.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for escape-sdk 2.2.1
File Interpreter ABI Platform
escape_sdk-2.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 268.4 kB

Release files / escape_sdk-2.2.1.tar.gz

Download URL escape_sdk-2.2.1.tar.gz
Size 119.9 kB
Tags Source
SHA-256 checksum
How to use checksums
06c86f2dbfd28c9ea4400d882e97e7560d0431460b63b2ca4f8277338b8cb9bd
BLAKE2b-256 checksum
How to use checksums
ef9bab27a6e846bb361557196a162d7f0fc81ad60f881cc4f32544575ba59e5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release files / escape_sdk-2.2.1-py3-none-any.whl

Download URL escape_sdk-2.2.1-py3-none-any.whl
Size 148.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d93d0a1c2e38172b22034c6a76c5ffee36eec9c77a4fa580f60bbd7f76200bb5
BLAKE2b-256 checksum
How to use checksums
8f8db704b8475557f3c2790c7dbe42fdf6e636d5b4f628536d9ef5ffbba9988e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release history Release notifications | RSS feed

This release

2.2.1 This release

2 release files

2.2.0

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page