This release is a pre-release and may not be stable for production use.
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:
- 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!
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aiontfy-0.8.6rc0.tar.gz.
File metadata
- Download URL: aiontfy-0.8.6rc0.tar.gz
- Upload date:
- Size: 26.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
Hatch/1.18.0 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.18.0"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
88b329d65eb02850b0fb7ba8335f6b2c2456064dd2a308e14bf8e52c0dcd0cdb
|
|
| MD5 |
a54821cbabda5eef90630983736526c3
|
|
| BLAKE2b-256 |
8d03e634c9a8f852efde0caa7c15e91f08a9bdb40e2e0c3319ea2df2baab0e20
|
File details
Details for the file aiontfy-0.8.6rc0-py3-none-any.whl.
File metadata
- Download URL: aiontfy-0.8.6rc0-py3-none-any.whl
- Upload date:
- Size: 15.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
Hatch/1.18.0 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.18.0"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0e471c6f3501cd25187fa05edfd012a8ea8aba7e9beb171fc9c34f07cd766ca
|
|
| MD5 |
a377a25f7c2bdea0d4b16cc3a2ccab4b
|
|
| BLAKE2b-256 |
68712e52a5c5499e9f88ea5f69bc81736621717f076f4f85f343500d36722986
|
