A Python Library For ntfy

An easy-to-use python library for the ntfy notification service. Aiming for full feature support and a super easy to use interface.

Quickstart

1. Install using pip with pip3 install python-ntfy
2. Configure the following environment variables:
   • NTFY_USER: The username for your server (if required)
   • NTFY_PASSWORD: The password for your server (if required)
   • NTFY_SERVER: The server URL (defaults to https://ntft.sh)
3. Setup your application to use the library:

# Import the ntfy client
from python_ntfy import NtfyClient

# Create an `NtfyClient` instance with a topic
client = NtfyClient(topic="Your topic")

# Send a message
client.send("Your message here")

Documentation

See the full documentation at https://matthewcane.github.io/python-ntfy/.

Supported Features

• Username + password auth
• Access token auth
• Custom servers
• Sending plaintext messages
• Sending Markdown formatted text messages
• Scheduling messages
• Retrieving cached messages
• Scheduled delivery
• Tags
• Action buttons

Future Features

• Email notifications
• Send to multiple topics at once

Contributing

This project uses:

• Poetry as it's dependency manager
• Just as a task runner
• Pre-commit for running checks before each commit
• Docker and Docker Compose for running tests

These need to be installed separately to run the tasks.

To see all available tasks, run just.

Some useful tasks are:

• just install - Install dependencies (including dev dependencies)
• just test - Run all tests and checks
• just serve-docs - Build and serve the docs locally

Tests

This project is aiming for 95% code coverage. Any added features must include comprehensive tests.