Skip to content

README.md

Latest commit

 

History

History
48 lines (34 loc) · 1.76 KB

README.md

File metadata and controls

48 lines (34 loc) · 1.76 KB

A Python Library For ntfy

GitHub Release PyPI - Python Version PyPI Downloads GitHub Actions Workflow Status

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. Use the NtfyClient to send messages:
# 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")

For information on setting up authentication, see the quickstart guide.

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
  • Email notifications

Contributing

We welcome contributions. Please see the full guidelines in CONTRIBUTING.md.