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.0.tar.gz (7.2 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.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_ntfy-0.11.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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.0.tar.gz
Algorithm Hash digest
SHA256 80d4beffa79c9cf048270b055e42716c4ef6919c6e96c74e03a098b938d97a45
MD5 40f2a0ad9a03f79ee2d9654aab648218
BLAKE2b-256 4b596ec121a88a56f7b053fc2a41cd359da0d5b4f1b5b8a293b58bcf93b0d8c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_ntfy-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 231e739988a83eb7f1961d850e030c6fd53b5fc959a40fb0840eb5ee8e1483ea
MD5 4f441a628547aa942776b923b756832b
BLAKE2b-256 903b36da8b2446a4e4debefc692ed5514f62403e634cea5d3d6b0120bfe1caae

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