{"id":27365,"library":"rook","title":"Rook","description":"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).","status":"active","version":"0.1.209","language":"python","source_language":"en","source_url":"https://github.com/rook/rook","tags":["debugging","production","data-extraction","rook"],"install":[{"cmd":"pip install rook","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"The primary class for interacting with Rook.","symbol":"RookClient","correct":"from rook import RookClient"},{"note":"start_rook is a top-level function, not in a submodule.","wrong":"from rook.client import start_rook","symbol":"start_rook","correct":"from rook import start_rook"}],"quickstart":{"code":"from rook import RookClient\n\nclient = RookClient(api_key=os.environ.get('ROOK_API_KEY', ''))\n# Use client to query and execute scripts on remote service\n","lang":"python","description":"Initialize RookClient with an API key. Then use the client to remotely debug or extract data from a running Python application."},"warnings":[{"fix":"Ensure the Rook agent is installed and running in your production environment.","message":"Rook requires the target application to be running with the Rook agent enabled. Without the agent, RookClient cannot connect.","severity":"gotcha","affected_versions":"all"},{"fix":"Verify that ROOK_API_KEY environment variable is set correctly on both client and server.","message":"The API key used in RookClient must match the key configured on the target application. Mismatched keys cause silent failures.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install rook' and ensure you are using the same Python environment.","cause":"rook not installed or installed in wrong environment.","error":"ModuleNotFoundError: No module named 'rook'"},{"fix":"Check that the Rook agent is running on the target host and that the client is configured with the correct endpoint.","cause":"Rook agent not running or incorrect host/port configuration.","error":"rook.exceptions.RookConnectionError: Failed to connect to Rook server"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}