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.1.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.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_ntfy-0.11.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.1.tar.gz
Algorithm Hash digest
SHA256 e0492b914d74ba002a6b55e400e722ea3a094a0edfb4d5fb6166477d96debbce
MD5 3601af67caa46eed2c4a7af88da1a373
BLAKE2b-256 36ad27cf3449f09759e8ab5e1dee17ddb3ca7e369db951aca944d3f03a6198b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_ntfy-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 039ffa0bb6861cf1d6a55e391162db323a1daa1fe3be2c64c814d4ec29a088ec
MD5 ebb982006227d5b9e0da3949d0abaa35
BLAKE2b-256 5dd12d64d24704c313d7a28817871c34d0cf4be413366775f1ccaf17015b158b

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