# PushX
One-Stop Python Push Solution.
## Introduction
Python-based Aggregate Push Module
## Supported Push Providers
- [x] Ntfy
- [x] ServerChan3
- [x] ServerChanTurbo
- [ ] And more...
## Install
```bash
pip install pushx
```
## Usage
The docs is [here](https://illustar0.github.io/PushX), you can also refer to the Examples below.
## Examples
### Example 1
```python
from pushx import Notifier, providers
n = Notifier(providers.ServerChan3, sendkey="666",uid=2233)
n.notify(title="test title",desp="test content")
# content/message=("content") is also fine
```
### Example 2
```python
from pushx import Notifier, providers
n = Notifier(providers.Ntfy, topic="233233233")
p = providers.Ntfy.NotifyParams(
title="test title",
message=("test message"), # content=("test message") is also fine
tags=["tag1", "tag2"],
priority=5,
markdown=True,
actions=[
{
"action": "view",
"label": "Open portal",
"url": "https://home.nest.com/",
"clear": True,
},
{
"action": "http",
"label": "Turn down",
"url": "https://api.nest.com/",
"body": '{"temperature": 65}',
},
],
click="https://illustar0.com",
)
n.notify(p)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Illustar0/PushX",
"name": "pushx",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "push, python, allinone, AIO",
"author": "Illustar0",
"author_email": "me@illustar0.com",
"download_url": "https://files.pythonhosted.org/packages/f1/7e/ada0064f05472c4fdf14085145f82416b4fe34cc28a014270b16084f3205/pushx-0.4.0.tar.gz",
"platform": null,
"description": "# PushX \nOne-Stop Python Push Solution.\n## Introduction\nPython-based Aggregate Push Module\n\n## Supported Push Providers\n- [x] Ntfy\n- [x] ServerChan3\n- [x] ServerChanTurbo \n- [ ] And more...\n\n## Install\n\n```bash\npip install pushx\n```\n\n## Usage\nThe docs is [here](https://illustar0.github.io/PushX), you can also refer to the Examples below. \n\n## Examples\n### Example 1\n```python\nfrom pushx import Notifier, providers\n\nn = Notifier(providers.ServerChan3, sendkey=\"666\",uid=2233)\nn.notify(title=\"test title\",desp=\"test content\")\n# content/message=(\"content\") is also fine\n```\n### Example 2\n```python\nfrom pushx import Notifier, providers\n\nn = Notifier(providers.Ntfy, topic=\"233233233\")\np = providers.Ntfy.NotifyParams(\n title=\"test title\",\n message=(\"test message\"), # content=(\"test message\") is also fine\n tags=[\"tag1\", \"tag2\"],\n priority=5,\n markdown=True,\n actions=[\n {\n \"action\": \"view\",\n \"label\": \"Open portal\",\n \"url\": \"https://home.nest.com/\",\n \"clear\": True,\n },\n {\n \"action\": \"http\",\n \"label\": \"Turn down\",\n \"url\": \"https://api.nest.com/\",\n \"body\": '{\"temperature\": 65}',\n },\n ],\n click=\"https://illustar0.com\",\n)\nn.notify(p)\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "One-Stop Python Push Solution",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/Illustar0/PushX",
"Repository": "https://github.com/Illustar0/PushX"
},
"split_keywords": [
"push",
" python",
" allinone",
" aio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdc1595d5030b8513e4dec85edd4b055326a9f8bf2ba836c1f68f4b5b5f98ecf",
"md5": "964b1a5901b0956b0107fb6de661baa0",
"sha256": "c90a870aab9116f4a6357b17f0cdd77eac99bdde455af7d9704e0452220b67cb"
},
"downloads": -1,
"filename": "pushx-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "964b1a5901b0956b0107fb6de661baa0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 8218,
"upload_time": "2025-02-09T09:40:22",
"upload_time_iso_8601": "2025-02-09T09:40:22.717577Z",
"url": "https://files.pythonhosted.org/packages/fd/c1/595d5030b8513e4dec85edd4b055326a9f8bf2ba836c1f68f4b5b5f98ecf/pushx-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f17eada0064f05472c4fdf14085145f82416b4fe34cc28a014270b16084f3205",
"md5": "4f182ada7be1c88d2d3dd0842e04c1b5",
"sha256": "e15b61772c69ce3f62deaf45c12f24463ef98fdac0ef065f82ba427566cf76ea"
},
"downloads": -1,
"filename": "pushx-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "4f182ada7be1c88d2d3dd0842e04c1b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4724,
"upload_time": "2025-02-09T09:40:24",
"upload_time_iso_8601": "2025-02-09T09:40:24.328278Z",
"url": "https://files.pythonhosted.org/packages/f1/7e/ada0064f05472c4fdf14085145f82416b4fe34cc28a014270b16084f3205/pushx-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-09 09:40:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Illustar0",
"github_project": "PushX",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pushx"
}
JSON
