aiontfy

Asynchronous client library for the ntfy pub-sub notification service

PyPI - Downloads

📖 Documentation

Full Documentation: https://tr4nt0r.github.io/aiontfy
Source Code: https://github.com/tr4nt0r/aiontfy

📦 Installation

You can install aiontfy via pip:

pip install aiontfy

🚀 Usage

Basic Examples

"""Publish to a ntfy topic."""

import asyncio

from aiohttp import ClientSession

from aiontfy import Message, Ntfy


async def main() -> None:
    async with ClientSession() as session:

        ntfy = Ntfy("https://ntfy.sh", session)

        message = Message(
            topic="aiontfy",
            title="Hello",
            message="World",
            click="https://example.com/",
            delay="10s",
            priority=3,
            tags=["octopus"],
        )
        print(await ntfy.publish(message))

asyncio.run(main())

"""Subscribe to ntfy topics."""

import asyncio

from aiohttp import ClientSession

from aiontfy import Event, Notification, Ntfy


def callback(message: Notification) -> None:
    """Process notifications callback function."""
    if message.event is Event.MESSAGE:
        print(message.to_dict())


async def main() -> None:
    async with ClientSession() as session:
        ntfy = Ntfy("https://ntfy.sh", session)

        await ntfy.subscribe(
            ["aiontfy", "test"],  # Subscribe to multiple topics
            callback,
            priority=[3, 4, 5],  # Only subscribe to priority >= 3
        )


asyncio.run(main())

For more advanced usage, refer to the documentation.

🛠 Contributing

Contributions are welcome! To contribute:

Fork the repository.
Create a new branch.
Make your changes and commit them.
Submit a pull request.

Make sure to follow the contributing guidelines.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

❤️ Support

If you find this project useful, consider buying me a coffee ☕ or sponsoring me on GitHub!

Metadata

Release files for aiontfy 0.8.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiontfy 0.8.4
File	Size	Uploaded
aiontfy-0.8.4.tar.gz	26.5 kB	Mar 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for aiontfy 0.8.4
File	Interpreter	ABI	Platform	Reset
aiontfy-0.8.4-py3-none-any.whl 15.4 kB Mar 30, 2026	Python 3	none	any	Details

Total release size: 42.0 kB

Release files / aiontfy-0.8.4.tar.gz

Download URL	aiontfy-0.8.4.tar.gz
Size	26.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`3eb240e59b1af0403844dd8a060a499a54e1678daa317918340d5abd027cf897`
BLAKE2b-256 checksum How to use checksums	`eaaec75306c8a09f9c8d46de8df4b9b72383e7ed7b27d669d46b214a279a3482`
Upload date	Mar 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1`

Release files / aiontfy-0.8.4-py3-none-any.whl

Download URL	aiontfy-0.8.4-py3-none-any.whl
Size	15.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f0d9a969c973cc3237ccca280492fca57ee7620ec3e9d99569ba06f2ae95965d`
BLAKE2b-256 checksum How to use checksums	`6e7a3d58c90bec64eda711bbff5858eccdcbc8491cd6708629a54135f53db940`
Upload date	Mar 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1`