Registry / observability / rook

rook

JSON →
library0.1.209pypypiunverified

Rook is a Python package for on-the-fly debugging and data extraction in production. It allows you to run ad-hoc Python scripts, inspect live variables, and modify behavior without redeploying. Current version: 0.1.209. Release cadence is frequent (multiple versions per week).

observabilitydevops
pip install rook
package ↗homepage ↗
INSTALL
IMPORT
SIG · ROOK
R
rook
observabilitypythonv0.1.209
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

RookClient
✓ from rook import RookClient
The primary class for interacting with Rook.
start_rook
✓ from rook import start_rook
✗ from rook.client import start_rook
start_rook is a top-level function, not in a submodule.

Initialize RookClient with an API key. Then use the client to remotely debug or extract data from a running Python application.

from rook import RookClient client = RookClient(api_key=os.environ.get('ROOK_API_KEY', '')) # Use client to query and execute scripts on remote service
rook --version
Debug
Known issues
gotchaRook requires the target application to be running with the Rook agent enabled. Without the agent, RookClient cannot connect.
fix
Ensure the Rook agent is installed and running in your production environment.
affects: all
gotchaThe API key used in RookClient must match the key configured on the target application. Mismatched keys cause silent failures.
fix
Verify that ROOK_API_KEY environment variable is set correctly on both client and server.
affects: all
Upgrade
Version history
0.1.209latest on PyPI · released Jul 2, 2023
Audit
Dependencies

No dependency data recorded yet.

Agent activity
17 hits · last 30 days
node
14
OpenAI (training)
2
Resources
packagehttps://pypi.org/project/rook/ ↗
homepagehttp://rookout.com/ ↗