jupyterlab_notifications_extension 1.1.24 → 1.1.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +9 -23
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -130,39 +130,25 @@ await app.commands.execute('jupyterlab-notifications:send', {
130
130
 
131
131
  ### CLI Tool
132
132
 
133
- The `jupyter-notify` command is installed with the extension:
133
+ The `jupyterlab-notify` command is installed with the extension:
134
134
 
135
135
  ```bash
136
- # Local mode (default) - adds directly to notification store
137
- jupyter-notify -m "Deployment complete" -t success
138
- # Output: Mode: Local | Type: success
139
- # Notification queued: notif_1765552888047_0
140
-
141
- # API mode - auto-detects URL from environment
142
- jupyter-notify --use-api -m "Build finished"
143
- # Output: Mode: API | URL: http://127.0.0.1:8888/jupyterhub/user/alice | Type: info
136
+ # Basic notification (auto-detects URL from running servers)
137
+ jupyterlab-notify -m "Deployment complete" -t success
138
+ # Output: URL: http://127.0.0.1:8888/jupyterhub/user/alice | Type: success
144
139
  # Notification sent: notif_1765552893662_0
145
140
 
146
- # API mode with explicit URL (--url implies --use-api)
147
- jupyter-notify --url "http://127.0.0.1:8888/jupyterhub/user/alice" -m "Hello"
141
+ # With explicit URL (e.g., JupyterHub)
142
+ jupyterlab-notify --url "http://127.0.0.1:8888/jupyterhub/user/alice" -m "Hello"
148
143
 
149
144
  # Persistent warning (no auto-close)
150
- jupyter-notify -m "System maintenance in 1 hour" -t warning --no-auto-close
145
+ jupyterlab-notify -m "System maintenance in 1 hour" -t warning --no-auto-close
151
146
 
152
147
  # Silent mode (notification center only, no toast)
153
- jupyter-notify -m "Background task finished" --auto-close 0
148
+ jupyterlab-notify -m "Background task finished" --auto-close 0
154
149
  ```
155
150
 
156
- **Modes**:
157
-
158
- - **Local** (default): Adds notifications directly to the in-memory store. Works when running in the same Python environment as JupyterLab (e.g., from a notebook terminal)
159
- - **API** (`--use-api` or `--url`): Sends via HTTP. Use for remote servers or when running outside JupyterLab's process
160
-
161
- **Environment variables** (for API mode URL auto-detection):
162
-
163
- - `JUPYTER_SERVER_URL` - explicit server URL
164
- - `JUPYTERHUB_SERVICE_PREFIX` - JupyterHub user path (e.g., `/jupyterhub/user/alice`)
165
- - `JUPYTER_PORT` - server port (default: 8888)
151
+ **URL auto-detection**: Queries `jupyter server list --json` to find running servers and constructs localhost URL. Falls back to `JUPYTERHUB_SERVICE_PREFIX` environment variable or `localhost:8888`.
166
152
 
167
153
  ### cURL
168
154
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jupyterlab_notifications_extension",
3
- "version": "1.1.24",
3
+ "version": "1.1.26",
4
4
  "description": "Jupyterlab extension to receive and display notifications in the main panel. Those can be from the jupyterjub administrator or from other places.",
5
5
  "keywords": [
6
6
  "jupyter",