jupyterlab_notifications_extension 1.1.21 → 1.1.23

package/README.md

@@ -128,44 +128,58 @@ await app.commands.execute('jupyterlab-notifications:send', {
 });
 ```
 
-### Python Script
+### CLI Tool
 
-The included script auto-detects tokens from `JUPYTERHUB_API_TOKEN`, `JPY_API_TOKEN`, or `JUPYTER_TOKEN` environment variables:
+The `jupyter-notify` command is installed with the extension:
 
 ```bash
-# Basic notification
-./scripts/send_notification.py --message "Deployment complete" --type success
+# Local mode (default) - adds directly to notification store
+jupyter-notify -m "Deployment complete" -t success
+# Output: Mode: Local | Type: success
+#         Notification queued: notif_1765552888047_0
+
+# API mode - auto-detects URL from environment
+jupyter-notify --use-api -m "Build finished"
+# Output: Mode: API | URL: http://127.0.0.1:8888/jupyterhub/user/alice | Type: info
+#         Notification sent: notif_1765552893662_0
+
+# API mode with explicit URL (--url implies --use-api)
+jupyter-notify --url "http://127.0.0.1:8888/jupyterhub/user/alice" -m "Hello"
 
 # Persistent warning (no auto-close)
-./scripts/send_notification.py --message "System maintenance in 1 hour" --type warning --no-auto-close
+jupyter-notify -m "System maintenance in 1 hour" -t warning --no-auto-close
 
-# Silent mode (notification center only)
-./scripts/send_notification.py --message "Background task finished" --auto-close 0
+# Silent mode (notification center only, no toast)
+jupyter-notify -m "Background task finished" --auto-close 0
 ```
 
+**Modes**:
+- **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)
+- **API** (`--use-api` or `--url`): Sends via HTTP. Use for remote servers or when running outside JupyterLab's process
+
+**Environment variables** (for API mode URL auto-detection):
+- `JUPYTER_SERVER_URL` - explicit server URL
+- `JUPYTERHUB_SERVICE_PREFIX` - JupyterHub user path (e.g., `/jupyterhub/user/alice`)
+- `JUPYTER_PORT` - server port (default: 8888)
+
 ### cURL
 
 ```bash
-# Basic info notification
+# Localhost - no authentication required
 curl -X POST http://localhost:8888/jupyterlab-notifications-extension/ingest \
   -H "Content-Type: application/json" \
-  -H "Authorization: token YOUR_TOKEN" \
-  -d '{"message": "Build completed", "type": "info"}'
+  -d '{"message": "Build completed", "type": "success"}'
 
-# Error notification with action button
+# Localhost - warning that stays until dismissed
 curl -X POST http://localhost:8888/jupyterlab-notifications-extension/ingest \
   -H "Content-Type: application/json" \
-  -H "Authorization: token YOUR_TOKEN" \
-  -d '{
-    "message": "Build failed on main branch",
-    "type": "error",
-    "autoClose": false,
-    "actions": [{
-      "label": "View Logs",
-      "caption": "Open build logs",
-      "displayType": "accent"
-    }]
-  }'
+  -d '{"message": "System maintenance in 1 hour", "type": "warning", "autoClose": false}'
+
+# Remote - requires authentication token
+curl -X POST http://jupyterhub.example.com/user/alice/jupyterlab-notifications-extension/ingest \
+  -H "Content-Type: application/json" \
+  -H "Authorization: token YOUR_JUPYTER_TOKEN" \
+  -d '{"message": "Deployment complete", "type": "info"}'
 ```
 
 ## Architecture

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyterlab_notifications_extension",
-    "version": "1.1.21",
+    "version": "1.1.23",
     "description": "Jupyterlab extension to receive and display notifications in the main panel. Those can be from the jupyterjub administrator or from other places.",
     "keywords": [
         "jupyter",