Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
holesch committed Jan 30, 2024
1 parent 9e79dc4 commit 3422999
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ newline to stdout. This can be an alternative to [`sd_notify(3)`] or

## Installation

There's a package published on PyPi, so it can be installed either with `pip`,
or globally with `pipx`:
There's a [package published on PyPi][1], so it can be installed either with
`pip`, or globally with `pipx`:

```
$ sudo PIPX_HOME=/opt/pipx PIPX_BIN_DIR=/usr/local/bin pipx install sdnotify-wrapper-py
```

[package]: https://pypi.org/project/sdnotify-wrapper-py/

## Usage

In your service write one line to stdout whenever the service is ready (make
Expand Down Expand Up @@ -55,13 +57,13 @@ systemd when it reads a newline and exit.
## Why Python?

`sdnotify-wrapper` is a tool originally written by Laurent Bercot:
[`sdnotify-wrapper.c`][1]. Unfortunately this tool is not packaged for any of
the major Linux distributions, so it's not a great user experience if your
service requires this mechanism.
[`sdnotify-wrapper.c`]. Unfortunately this tool is not packaged for any of the
major Linux distributions, so it's not a great user experience if your service
requires this mechanism.

I chose to reimplement this tool in Python mainly, because it's easier to
install it with a Python package manager. In doing this, I hope this readiness
notification mechanism will be adopted by more projects and the original tool
will be packaged by more distributions.

[1]: https://www.skarnet.org/software/misc/sdnotify-wrapper.c
[`sdnotify-wrapper.c`]: https://www.skarnet.org/software/misc/sdnotify-wrapper.c

0 comments on commit 3422999

Please sign in to comment.