aiontfy 0.8.1

Async ntfy client library

aiontfy

Asynchronous client library for the ntfy pub-sub notification service

---

📖 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:

1. Fork the repository.
2. Create a new branch.
3. Make your changes and commit them.
4. 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!