SwanNotificationsService

JupyterHub service that exposes an API with notifications for the logged in user. The notifications are specified in a json file. If a "maintenance file" exists, a notification will be given that the service is under maintenance.

This extension works in conjunction with SwanNotifications.

Requirements

This module requires and installs JupyterHub.

Installation

Install the package:

pip install swannotificationsservice

Update the container image

This folder contains a Dockerfile that can be used to create an image for the pod that runs the notifications service. Once you release to PyPI you need to create a new image, e.g.

docker build -t gitlab-registry.cern.ch/swan/docker-images/jupyterhub/notifications:v0.1.0 && docker push gitlab-registry.cern.ch/swan/docker-images/jupyterhub/notifications:v0.1.0

Usage

Call the binary and specify configuration parameters:

swannotificationsservice --notifications_file /srv/jupyterhub/notifications.json

Configuration parameters:

port (default: 8888)
notifications_file (default: /srv/jupyterhub/notifications.json)
maintenance_file (default: /etc/nologin)
prefix (default: /)

Notifications file example:

[
    {
        "user": "*",
        "id": "notif1",
        "level": "info",
        "dismissible": 0,
        "message": "This is a notification"
    }
]

Explanation:

user: username or '*' for all users;
id: unique identifier;
level: type of the notification (notice, info, success, or error)
dismissible: wether the user will be able to permanently hide the notification (0 or 1)
message: the text/html message

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swannotificationsservice-1.0.5.tar.gz (3.7 kB view details)

Uploaded Apr 27, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

swannotificationsservice-1.0.5-py3-none-any.whl (4.7 kB view details)

Uploaded Apr 27, 2026 Python 3

File details

Details for the file swannotificationsservice-1.0.5.tar.gz.

File metadata

Download URL: swannotificationsservice-1.0.5.tar.gz
Upload date: Apr 27, 2026
Size: 3.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for swannotificationsservice-1.0.5.tar.gz
Algorithm	Hash digest
SHA256	`98fb442f688cfa5991b42708f9d40e36552bf48b6618beb975fdc6c6dd9d263d`
MD5	`726c8f6d8f1ea9cfd20c819884647567`
BLAKE2b-256	`ce7610de02492d1e0912a0a6bae6d5c685fff6e9d54c09d5b6930a1c6c03a63c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for swannotificationsservice-1.0.5.tar.gz:

Publisher: release.yml on swan-cern/jupyterhub-extensions

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: swannotificationsservice-1.0.5.tar.gz
- Subject digest: 98fb442f688cfa5991b42708f9d40e36552bf48b6618beb975fdc6c6dd9d263d
- Sigstore transparency entry: 1393620382
- Sigstore integration time: Apr 27, 2026
Source repository:
- Permalink: swan-cern/jupyterhub-extensions@e89f179ae671ef904815937b1ca6fca2480741f3
- Branch / Tag: refs/heads/master
- Owner: https://github.com/swan-cern
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@e89f179ae671ef904815937b1ca6fca2480741f3
- Trigger Event: workflow_dispatch