sdnotify

library0.3.2pypypi✓ verified 85d ago

sdnotify provides a pure Python implementation of systemd's service notification protocol (sd_notify). It allows Python services to communicate their status, readiness, and other information back to systemd, enabling robust service management. The current version is 0.3.2, with releases being infrequent, primarily for packaging or minor internal improvements.

devops

pip install sdnotify

github ↗package ↗

INSTALL

IMPORT

SIG · SDNOTIFY

sdnotify

devopspythonv0.3.2

Install

2.4s avg

Import

10ms

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.3.2 · 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.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.010s · 19.2MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 2.4s · import 0.008s · 20MB

17MB installed

● package 17MB

Code

Verified usage

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

SystemdNotifier

✓ from sdnotify import SystemdNotifier

This quickstart demonstrates how to initialize `SystemdNotifier` and send status messages, including `READY=1` and `STATUS` updates, to systemd. This script should be run as a `Type=notify` service under systemd to observe the notifications.

import time from sdnotify import SystemdNotifier def main(): notifier = SystemdNotifier() print("Sending NOTIFY_SOCKET check (silently fails if not running under systemd)") # Send 'READY=1' to signal that the service is initialized notifier.notify("READY=1") print("Service ready. Working...") for i in range(1, 4): status_message = f"STATUS=Working on task {i} of 3..." print(status_message) notifier.notify(status_message) time.sleep(2) # Simulate work # Send 'STOPPING=1' or just exit (systemd can infer STOPPING upon exit) print("Service finished work. Sending STOPPING=1.") notifier.notify("STOPPING=1") if __name__ == "__main__": main()

Debug

Known issues

gotchaNotifications are silently ignored if the `NOTIFY_SOCKET` environment variable is not set. This means your Python service is likely not running under systemd, or systemd is not configured to listen for notifications (e.g., `Type=notify` is missing in the unit file).

fix

Ensure your systemd unit file is configured with `Type=notify` and that the service is started correctly by systemd, allowing `NOTIFY_SOCKET` to be inherited by your Python process.

affects: All versions

gotchaSystemd expects a `READY=1` notification to mark the service as successfully started. Forgetting to send this can cause systemd to prematurely consider the service failed or stalled, leading to restarts or timeouts.

fix

Always send `notifier.notify('READY=1')` once your service is fully initialized and ready to accept requests. This is crucial for proper service lifecycle management by systemd.

affects: All versions

breakingVersions prior to `0.3.0` were considered experimental and may have been non-functional or had an unstable API. The `sdnotify` functionality became reliably available starting with `0.3.0`.

fix

Upgrade to `0.3.0` or later to ensure stable and working functionality with the standard systemd notification protocol.

affects: <0.3.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'sdnotify'

The `sdnotify` library is not installed in the Python environment being used to run your service.

fix

Install the package using pip: `pip install sdnotify`.

Systemd service unit reports 'failed' or 'timeout' even though Python script appears to run.

This often happens if the systemd unit file's `Type` is not set to `notify`, or if the Python service fails to send `READY=1` to systemd upon startup.

fix

In your `.service` unit file, ensure `Type=notify` is set. In your Python code, confirm that `notifier.notify('READY=1')` is called after all initialization steps are complete.

Upgrade

Version history

0.3.2latest on PyPI · released Aug 2, 2017

Audit

Dependencies

No dependency data recorded yet.

Agent activity

11 hits · last 30 days

node

Resources

githubhttps://github.com/bb4242/sdnotify ↗

packagehttps://pypi.org/project/sdnotify/ ↗