Skip to main content

An easy-to-use library for the ntfy notification service.

Project description

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.

Project details


Download files

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

Source Distribution

python_ntfy-0.11.2.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

python_ntfy-0.11.2-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file python_ntfy-0.11.2.tar.gz.

File metadata

  • Download URL: python_ntfy-0.11.2.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for python_ntfy-0.11.2.tar.gz
Algorithm Hash digest
SHA256 fc02284e04978074c7d7c03c51d0ae1f772514df7eee845c7854362fa3d3d611
MD5 fdd8e489a212e15b58bd42a1badc2bf5
BLAKE2b-256 f1bd24561afca65c4eb2f42e544a619ef855b1428deb7ee0804f8eeb05e9b28b

See more details on using hashes here.

File details

Details for the file python_ntfy-0.11.2-py3-none-any.whl.

File metadata

  • Download URL: python_ntfy-0.11.2-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for python_ntfy-0.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c51f8a19cf159e098498b6d9a839a3d8e7fe1feefe2dd611b2b058aac5f5fde3
MD5 7311c85888638cd3ae53d65a1d73885a
BLAKE2b-256 9a9d777a2db1579aacc3f1165251f21bb40bb1396725bb7a9339adea5c4e1b7e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page