# A Python Library For ntfy
[](https://pepy.tech/projects/python-ntfy)
[](https://pepy.tech/projects/python-ntfy)
An easy-to-use python library for the [ntfy notification service](https://ntfy.sh/). 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:
```python
# 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](https://matthewcane.github.io/python-ntfy/quickstart/).
## Documentation
See the full documentation at [https://matthewcane.github.io/python-ntfy/](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`](./CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "python-ntfy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ntfy, notifications, push, http, api",
"author": "Matthew Cane",
"author_email": "Matthew Cane <matthew.cane0@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1a/a4/435c54e9402a18349e3d224ff11b6b5710d270b0f661ef67d5930dbbe450/python_ntfy-0.10.0.tar.gz",
"platform": null,
"description": "# A Python Library For ntfy\n\n\n[](https://pepy.tech/projects/python-ntfy)\n[](https://pepy.tech/projects/python-ntfy)\n\n\nAn easy-to-use python library for the [ntfy notification service](https://ntfy.sh/). Aiming for full feature support and a super easy to use interface.\n\n## Quickstart\n\n1. Install using pip with `pip3 install python-ntfy`\n2. Use the `NtfyClient` to send messages:\n\n```python\n# Import the ntfy client\nfrom python_ntfy import NtfyClient\n\n# Create an `NtfyClient` instance with a topic\nclient = NtfyClient(topic=\"Your topic\")\n\n# Send a message\nclient.send(\"Your message here\")\n```\n\nFor information on setting up authentication, see the [quickstart guide](https://matthewcane.github.io/python-ntfy/quickstart/).\n\n## Documentation\n\nSee the full documentation at [https://matthewcane.github.io/python-ntfy/](https://matthewcane.github.io/python-ntfy/).\n\n## Supported Features\n\n- Username + password auth\n- Access token auth\n- Custom servers\n- Sending plaintext messages\n- Sending Markdown formatted text messages\n- Scheduling messages\n- Retrieving cached messages\n- Scheduled delivery\n- Tags\n- Action buttons\n- Email notifications\n\n## Contributing\n\nWe welcome contributions. Please see the full guidelines in [`CONTRIBUTING.md`](./CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": null,
"summary": "An easy-to-use library for the ntfy notification service.",
"version": "0.10.0",
"project_urls": {
"Changelog": "https://github.com/matthewcane/python-ntfy/releases",
"Documentation": "https://matthewcane.github.io/python-ntfy/",
"Homepage": "https://github.com/matthewcane/python-ntfy",
"Issues": "https://github.com/matthewcane/python-ntfy/issues",
"Repository": "https://github.com/matthewcane/python-ntfy"
},
"split_keywords": [
"ntfy",
" notifications",
" push",
" http",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "22f9ddd0abac187ed53c0fbb6407a9f1b08b9e433f63ed247a3985e77ccc573e",
"md5": "65914ee405e8ac52667d7101826ed88f",
"sha256": "d417aa0f07b4e916a8dc59d6ff31f23afa87483d34d8ad3446c34e349a45d4b7"
},
"downloads": -1,
"filename": "python_ntfy-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65914ee405e8ac52667d7101826ed88f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8276,
"upload_time": "2025-08-19T09:49:06",
"upload_time_iso_8601": "2025-08-19T09:49:06.895654Z",
"url": "https://files.pythonhosted.org/packages/22/f9/ddd0abac187ed53c0fbb6407a9f1b08b9e433f63ed247a3985e77ccc573e/python_ntfy-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1aa4435c54e9402a18349e3d224ff11b6b5710d270b0f661ef67d5930dbbe450",
"md5": "f9e6199d976ac7f90abd30ebc38f4522",
"sha256": "5fdfe5e8f21be2a12a5c977a9027b3e809430beeb314d72997e9b400b4d3bfb7"
},
"downloads": -1,
"filename": "python_ntfy-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "f9e6199d976ac7f90abd30ebc38f4522",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7046,
"upload_time": "2025-08-19T09:49:08",
"upload_time_iso_8601": "2025-08-19T09:49:08.027591Z",
"url": "https://files.pythonhosted.org/packages/1a/a4/435c54e9402a18349e3d224ff11b6b5710d270b0f661ef67d5930dbbe450/python_ntfy-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 09:49:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matthewcane",
"github_project": "python-ntfy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-ntfy"
}
JSON
