Swarmauri Tool Jupyter Get Shell Message
Retrieves shell-channel messages from a running Jupyter kernel using jupyter_client.
Features
- Listens on the Jupyter kernel shell channel and captures raw message dicts.
- Returns a dict containing
messagesor anerrorkey. - Helpful for debugging live kernel communication during automated notebook workflows.
Prerequisites
- Python 3.10 or newer.
- Access to a running Jupyter kernel (Notebook server, JupyterLab, etc.).
jupyter_clientandwebsocket-client(installed automatically).
Installation
# pip
pip install swarmauri_tool_jupytergetshellmessage
# poetry
poetry add swarmauri_tool_jupytergetshellmessage
# uv (pyproject-based projects)
uv add swarmauri_tool_jupytergetshellmessage
Quickstart
from swarmauri_tool_jupytergetshellmessage import JupyterGetShellMessageTool
channels_url = "ws://localhost:8888/api/kernels/<kernel-id>/channels"
result = JupyterGetIOPubMessageTool()(channels_url, timeout=5.0)
if "messages" in result:
for msg in result["messages"]:
print(msg)
else:
print("Error:", result.get("error"))
Tips
- Ensure you pass the correct kernel channels URL (including security tokens/cookies if your server requires them).
- Increase
timeoutif you expect long-running cells before shell replies are sent. - Combine with notebook execution tools to capture both SHELL and IOPub messages for full observability.
Want to help?
If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.
1 maintainer
Metadata
1 maintainer
Release files for swarmauri_tool_jupytergetshellmessage 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| swarmauri_tool_jupytergetshellmessage-0.10.0.tar.gz | 8.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| swarmauri_tool_jupytergetshellmessage-0.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.9 kB
Release files / swarmauri_tool_jupytergetshellmessage-0.10.0.tar.gz
| Download URL | swarmauri_tool_jupytergetshellmessage-0.10.0.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
18e4f4ffbdd6e65f6f58e05056e2ed574d55d4f60c259ed9aacf05925a9e82dd
|
|
BLAKE2b-256 checksum How to use checksums |
1055bf04229176c88130256aee96b99a3b3e1046ef11f1196f65f848884990ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / swarmauri_tool_jupytergetshellmessage-0.10.0-py3-none-any.whl
| Download URL | swarmauri_tool_jupytergetshellmessage-0.10.0-py3-none-any.whl |
|---|---|
| Size | 10.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
17545554ab2f954d92e61280847a106e867592a369c6f917e956bf4a0ae844e7
|
|
BLAKE2b-256 checksum How to use checksums |
936f74165c8851f5966ca6ad4722b4374e273a77531817447a9be65690a5e0f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
