Registry / web-framework / jupyter-resource-usage

jupyter-resource-usage

JSON →
library1.2.1pypypi✓ verified 83d ago

Jupyter extension displaying real-time memory, CPU, and disk usage for notebooks and the Jupyter server. Current version 1.2.1, released Dec 2024, with monthly releases.

pip install jupyter-resource-usage
INSTALL
IMPORT
SIG · JUPYTER-RESOURCE-U
J
jupyter-resource-usage
web-frameworkpythonv1.2.1
Install
8.1s avg
Import
Disk
68MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v1.2.1 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 68.1MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 8.1s · import 0.000s · 65MB
68MB installed
● package 68MB
Code
Verified usage

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

load_jupyter_server_extension
from jupyter_resource_usage import load_jupyter_server_extension
from jupyter_resource_usage import ResourceUsage
api
from jupyter_resource_usage import api
config
from jupyter_resource_usage import config

Fetch resource usage metrics from the Jupyter server API.

from jupyter_resource_usage import ResourceUsage # Requires a running Jupyter server; the extension auto-activates # To fetch current resource usage: import requests from notebook.auth import passwd response = requests.get( 'http://localhost:8888/api/metrics/v1', headers={'Authorization': 'token ' + os.environ.get('JUPYTER_TOKEN', '')} ) print(response.json())
Debug
Known issues
breakingVersion 1.0.0 moved from `jupyter-resource-usage` npm package to `@jupyter-server/resource-usage`. The Python package name changed from `jupyter-resource-usage` to `jupyter-server-resource-usage`? No, keep using jupyter-resource-usage. The breaking change is in the frontend extension. If you are using JupyterLab <3, you must pin to <1.0.0.
fix
Upgrade to JupyterLab 3+ or pin jupyter-resource-usage to 0.x.
affects: >=1.0.0
gotchaThe extension only reports memory/CPU of the notebook server process, not individual kernels. For per-kernel usage, use `jupyterlab-system-monitor`.
fix
Install jupyterlab-system-monitor for granular per-kernel metrics.
affects: all
deprecatedThe `/api/metrics/v1` endpoint is deprecated in favor of the Jupyter Server's `/api/kernels` and `psutil`-based metrics. Future versions may remove it.
fix
Use the Jupyter Server's REST API with `psutil` directly for custom monitoring.
affects: >=1.0.0
Upgrade
Version history
1.2.1latest on PyPI · released Mar 31, 2026
Audit
Dependencies

No dependency data recorded yet.

Agent activity
20 hits · last 30 days
node
18
OpenAI (training)
1
Resources
jupyter-resource-usage — pip install jupyter-resource-usage · libregistry