<div align="center">
<a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
<br>
<p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
</div>
<div align="center">
# nonebot-plugin-api-scheduler
_✨ 像操作API一样设置定时任务&计划任务✨_
<a href="./LICENSE">
<img src="https://img.shields.io/github/license/mmdexb/nonebot-plugin-api-scheduler.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-api-scheduler">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-template.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.11+-blue.svg" alt="python">
</div>
## 📖 介绍
通过NoneBot的FastAPI服务器来提供API，使得您能够对定时任务&计划任务进行增删改查。同时也提供了一个简易的WebUI
## 💿 安装
<details open>
<summary>使用 nb-cli 安装</summary>
在 nonebot2 项目的根目录下打开命令行<br> 首先安装前置依赖nonebot_plugin_apscheduler <br>
nb plugin install nonebot_plugin_apscheduler <br>
接下来安装本插件<br>
nb plugin install nonebot_plugin_api-scheduler<br>
</details>
<details>
<summary>使用包管理器安装</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令<br>
<summary>pip</summary>
首先安装前置依赖nonebot_plugin_apscheduler <br>
pip install nonebot_plugin_apscheduler<br>
接下来安装本插件 <br>
pip install nonebot_plugin_api-scheduler<br>
</details>
## ⚙️ 配置
在 nonebot2 项目的`.env`文件中添加下表中的必填配置
| 配置项 | 必填 | 默认值 | 说明 |
|:-----:|:----:|:----:|:----:|
| fastapi_docs_url = "/doc" | 否 | 无 | 设置fastapi文档地址 |
## 使用方法
[API文档](https://github.com/mmdexb/nonebot-plugin-api-scheduler/blob/master/API.md) <br>
[WebUI文档](https://github.com/mmdexb/nonebot-plugin-api-scheduler/blob/master/wiki.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/mmdexb/nonebot-plugin-api-scheduler/",
"name": "nonebot-plugin-api-scheduler",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "nonebot, nonebot2, scheduler",
"author": "mmdexb",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e7/0d/fb7a2210ec5d700a8b0d86c7bde938c7436e3ec05d860633be69d7f423c4/nonebot_plugin_api_scheduler-1.1.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://v2.nonebot.dev/store\"><img src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png\" width=\"180\" height=\"180\" alt=\"NoneBotPluginLogo\"></a>\n <br>\n <p><img src=\"https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg\" width=\"240\" alt=\"NoneBotPluginText\"></p>\n</div>\n\n<div align=\"center\">\n\n# nonebot-plugin-api-scheduler\n\n_\u2728 \u50cf\u64cd\u4f5cAPI\u4e00\u6837\u8bbe\u7f6e\u5b9a\u65f6\u4efb\u52a1&\u8ba1\u5212\u4efb\u52a1\u2728_\n\n\n<a href=\"./LICENSE\">\n <img src=\"https://img.shields.io/github/license/mmdexb/nonebot-plugin-api-scheduler.svg\" alt=\"license\">\n</a>\n<a href=\"https://pypi.python.org/pypi/nonebot-plugin-api-scheduler\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-template.svg\" alt=\"pypi\">\n</a>\n<img src=\"https://img.shields.io/badge/python-3.11+-blue.svg\" alt=\"python\">\n\n</div>\n\n\n\n\n\n## \ud83d\udcd6 \u4ecb\u7ecd\n\n\u901a\u8fc7NoneBot\u7684FastAPI\u670d\u52a1\u5668\u6765\u63d0\u4f9bAPI\uff0c\u4f7f\u5f97\u60a8\u80fd\u591f\u5bf9\u5b9a\u65f6\u4efb\u52a1&\u8ba1\u5212\u4efb\u52a1\u8fdb\u884c\u589e\u5220\u6539\u67e5\u3002\u540c\u65f6\u4e5f\u63d0\u4f9b\u4e86\u4e00\u4e2a\u7b80\u6613\u7684WebUI\n\n## \ud83d\udcbf \u5b89\u88c5\n\n<details open>\n<summary>\u4f7f\u7528 nb-cli \u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u6839\u76ee\u5f55\u4e0b\u6253\u5f00\u547d\u4ee4\u884c<br> \u9996\u5148\u5b89\u88c5\u524d\u7f6e\u4f9d\u8d56nonebot_plugin_apscheduler <br>\n nb plugin install nonebot_plugin_apscheduler <br>\n\u63a5\u4e0b\u6765\u5b89\u88c5\u672c\u63d2\u4ef6<br>\n nb plugin install nonebot_plugin_api-scheduler<br>\n\n</details>\n\n<details>\n<summary>\u4f7f\u7528\u5305\u7ba1\u7406\u5668\u5b89\u88c5</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c, \u6839\u636e\u4f60\u4f7f\u7528\u7684\u5305\u7ba1\u7406\u5668, \u8f93\u5165\u76f8\u5e94\u7684\u5b89\u88c5\u547d\u4ee4<br>\n<summary>pip</summary>\n\u9996\u5148\u5b89\u88c5\u524d\u7f6e\u4f9d\u8d56nonebot_plugin_apscheduler <br>\n pip install nonebot_plugin_apscheduler<br>\n\u63a5\u4e0b\u6765\u5b89\u88c5\u672c\u63d2\u4ef6 <br>\n pip install nonebot_plugin_api-scheduler<br>\n</details>\n\n\n\n## \u2699\ufe0f \u914d\u7f6e\n\n\u5728 nonebot2 \u9879\u76ee\u7684`.env`\u6587\u4ef6\u4e2d\u6dfb\u52a0\u4e0b\u8868\u4e2d\u7684\u5fc5\u586b\u914d\u7f6e\n\n| \u914d\u7f6e\u9879 | \u5fc5\u586b | \u9ed8\u8ba4\u503c | \u8bf4\u660e |\n|:-----:|:----:|:----:|:----:|\n| fastapi_docs_url = \"/doc\" | \u5426 | \u65e0 | \u8bbe\u7f6efastapi\u6587\u6863\u5730\u5740 |\n\n\n## \u4f7f\u7528\u65b9\u6cd5\n[API\u6587\u6863](https://github.com/mmdexb/nonebot-plugin-api-scheduler/blob/master/API.md) <br>\n[WebUI\u6587\u6863](https://github.com/mmdexb/nonebot-plugin-api-scheduler/blob/master/wiki.md)\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0 license",
"summary": "\u50cf\u64cd\u4f5cAPI\u4e00\u6837\u8bbe\u7f6e\u5b9a\u65f6\u4efb\u52a1&\u8ba1\u5212\u4efb\u52a1",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/mmdexb/nonebot-plugin-api-scheduler/",
"Repository": "https://github.com/mmdexb/nonebot-plugin-api-scheduler/"
},
"split_keywords": [
"nonebot",
" nonebot2",
" scheduler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd70af442d0ebd7316ab36abde0ad88aff8eafd4ecc0082d92b67484e0fb5c0e",
"md5": "9b2017f0733b9156f764f96163c7d381",
"sha256": "fa1526c2ecee07d798e1bac23e0a44b1c3f3c73019640f9169a7088be42cd995"
},
"downloads": -1,
"filename": "nonebot_plugin_api_scheduler-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b2017f0733b9156f764f96163c7d381",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 16523,
"upload_time": "2024-11-23T04:45:47",
"upload_time_iso_8601": "2024-11-23T04:45:47.074889Z",
"url": "https://files.pythonhosted.org/packages/cd/70/af442d0ebd7316ab36abde0ad88aff8eafd4ecc0082d92b67484e0fb5c0e/nonebot_plugin_api_scheduler-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e70dfb7a2210ec5d700a8b0d86c7bde938c7436e3ec05d860633be69d7f423c4",
"md5": "c93015de76ab27b58df2eef6e58d866d",
"sha256": "2d5a72c799c7227b7337d8f0125b21696c5d3dfa86e4a1229715ed560a30fe2a"
},
"downloads": -1,
"filename": "nonebot_plugin_api_scheduler-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "c93015de76ab27b58df2eef6e58d866d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 16012,
"upload_time": "2024-11-23T04:45:48",
"upload_time_iso_8601": "2024-11-23T04:45:48.509838Z",
"url": "https://files.pythonhosted.org/packages/e7/0d/fb7a2210ec5d700a8b0d86c7bde938c7436e3ec05d860633be69d7f423c4/nonebot_plugin_api_scheduler-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 04:45:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mmdexb",
"github_project": "nonebot-plugin-api-scheduler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nonebot-plugin-api-scheduler"
}
JSON
