nonebot-plugin-apscheduler


Namenonebot-plugin-apscheduler JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/nonebot/plugin-apscheduler
SummaryAPScheduler Support for NoneBot2
upload_time2024-02-12 13:56:50
maintainer
docs_urlNone
authoryanyongyu
requires_python>=3.8,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <p align="center">
  <a href="https://nonebot.dev/"><img src="https://nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>

<div align="center">

# NoneBot Plugin APScheduler

_✨ NoneBot APScheduler 定时任务插件 ✨_

</div>

<p align="center">
  <a href="https://raw.githubusercontent.com/nonebot/plugin-apscheduler/master/LICENSE">
    <img src="https://img.shields.io/github/license/nonebot/plugin-apscheduler.svg" alt="license">
  </a>
  <a href="https://pypi.python.org/pypi/nonebot-plugin-apscheduler">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-apscheduler.svg" alt="pypi">
  </a>
  <img src="https://img.shields.io/badge/python-3.7+-blue.svg" alt="python">
</p>

## 使用方式

加载插件后使用 `require` 获取 `scheduler` 对象（请注意插件加载顺序）

```python
from nonebot import require

require("nonebot_plugin_apscheduler")

from nonebot_plugin_apscheduler import scheduler

@scheduler.scheduled_job("cron", hour="*/2", id="xxx", args=[1], kwargs={"arg2": 2})
async def run_every_2_hour(arg1, arg2):
    pass

scheduler.add_job(run_every_day_from_program_start, "interval", days=1, id="xxx")
```

## 配置项

### apscheduler_autostart

是否自动启动 `scheduler`

### apscheduler_log_level

`int` 类型日志等级

- `WARNING` = `30` (默认)
- `INFO` = `20`
- `DEBUG` = `10` (只有在开启 nonebot 的 debug 模式才会显示 debug 日志)

### apscheduler_config

`apscheduler` 的相关配置。参考 [配置 scheduler](https://apscheduler.readthedocs.io/en/latest/userguide.html#scheduler-config), [配置参数](https://apscheduler.readthedocs.io/en/latest/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)

配置需要包含 `prefix: apscheduler.`

默认配置：

```json
{ "apscheduler.timezone": "Asia/Shanghai" }
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nonebot/plugin-apscheduler",
    "name": "nonebot-plugin-apscheduler",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "yanyongyu",
    "author_email": "yyy@nonebot.dev",
    "download_url": "https://files.pythonhosted.org/packages/24/1f/f10eafc3cda02f58150fff99dc527d1c4a3af3ffdcc975964ec0a4cfe409/nonebot_plugin_apscheduler-0.4.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <a href=\"https://nonebot.dev/\"><img src=\"https://nonebot.dev/logo.png\" width=\"200\" height=\"200\" alt=\"nonebot\"></a>\n</p>\n\n<div align=\"center\">\n\n# NoneBot Plugin APScheduler\n\n_\u2728 NoneBot APScheduler \u5b9a\u65f6\u4efb\u52a1\u63d2\u4ef6 \u2728_\n\n</div>\n\n<p align=\"center\">\n  <a href=\"https://raw.githubusercontent.com/nonebot/plugin-apscheduler/master/LICENSE\">\n    <img src=\"https://img.shields.io/github/license/nonebot/plugin-apscheduler.svg\" alt=\"license\">\n  </a>\n  <a href=\"https://pypi.python.org/pypi/nonebot-plugin-apscheduler\">\n    <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-apscheduler.svg\" alt=\"pypi\">\n  </a>\n  <img src=\"https://img.shields.io/badge/python-3.7+-blue.svg\" alt=\"python\">\n</p>\n\n## \u4f7f\u7528\u65b9\u5f0f\n\n\u52a0\u8f7d\u63d2\u4ef6\u540e\u4f7f\u7528 `require` \u83b7\u53d6 `scheduler` \u5bf9\u8c61\uff08\u8bf7\u6ce8\u610f\u63d2\u4ef6\u52a0\u8f7d\u987a\u5e8f\uff09\n\n```python\nfrom nonebot import require\n\nrequire(\"nonebot_plugin_apscheduler\")\n\nfrom nonebot_plugin_apscheduler import scheduler\n\n@scheduler.scheduled_job(\"cron\", hour=\"*/2\", id=\"xxx\", args=[1], kwargs={\"arg2\": 2})\nasync def run_every_2_hour(arg1, arg2):\n    pass\n\nscheduler.add_job(run_every_day_from_program_start, \"interval\", days=1, id=\"xxx\")\n```\n\n## \u914d\u7f6e\u9879\n\n### apscheduler_autostart\n\n\u662f\u5426\u81ea\u52a8\u542f\u52a8 `scheduler`\n\n### apscheduler_log_level\n\n`int` \u7c7b\u578b\u65e5\u5fd7\u7b49\u7ea7\n\n- `WARNING` = `30` (\u9ed8\u8ba4)\n- `INFO` = `20`\n- `DEBUG` = `10` (\u53ea\u6709\u5728\u5f00\u542f nonebot \u7684 debug \u6a21\u5f0f\u624d\u4f1a\u663e\u793a debug \u65e5\u5fd7)\n\n### apscheduler_config\n\n`apscheduler` \u7684\u76f8\u5173\u914d\u7f6e\u3002\u53c2\u8003 [\u914d\u7f6e scheduler](https://apscheduler.readthedocs.io/en/latest/userguide.html#scheduler-config), [\u914d\u7f6e\u53c2\u6570](https://apscheduler.readthedocs.io/en/latest/modules/schedulers/base.html#apscheduler.schedulers.base.BaseScheduler)\n\n\u914d\u7f6e\u9700\u8981\u5305\u542b `prefix: apscheduler.`\n\n\u9ed8\u8ba4\u914d\u7f6e\uff1a\n\n```json\n{ \"apscheduler.timezone\": \"Asia/Shanghai\" }\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "APScheduler Support for NoneBot2",
    "version": "0.4.0",
    "project_urls": {
        "Documentation": "https://github.com/nonebot/plugin-apscheduler#readme",
        "Homepage": "https://github.com/nonebot/plugin-apscheduler",
        "Repository": "https://github.com/nonebot/plugin-apscheduler"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3b95889d25f284701fbefd36f328ff18ced3ad655096669fa11eba1a8f340f8",
                "md5": "7aae1cfe61c7fd29239e7caf0955d80f",
                "sha256": "f01bb418a5ecf9f04dcadbbc2ff5ba565a48177eb0a758c8c46b13048ac5680c"
            },
            "downloads": -1,
            "filename": "nonebot_plugin_apscheduler-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7aae1cfe61c7fd29239e7caf0955d80f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 4111,
            "upload_time": "2024-02-12T13:56:49",
            "upload_time_iso_8601": "2024-02-12T13:56:49.110411Z",
            "url": "https://files.pythonhosted.org/packages/a3/b9/5889d25f284701fbefd36f328ff18ced3ad655096669fa11eba1a8f340f8/nonebot_plugin_apscheduler-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "241ff10eafc3cda02f58150fff99dc527d1c4a3af3ffdcc975964ec0a4cfe409",
                "md5": "7b66f0405d19f8b96ab3add45f864451",
                "sha256": "ba91e68809a38e6dbe28906366d47f37f754ded360944b938cd5ac62029a0eb6"
            },
            "downloads": -1,
            "filename": "nonebot_plugin_apscheduler-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7b66f0405d19f8b96ab3add45f864451",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 3414,
            "upload_time": "2024-02-12T13:56:50",
            "upload_time_iso_8601": "2024-02-12T13:56:50.118621Z",
            "url": "https://files.pythonhosted.org/packages/24/1f/f10eafc3cda02f58150fff99dc527d1c4a3af3ffdcc975964ec0a4cfe409/nonebot_plugin_apscheduler-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-12 13:56:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nonebot",
    "github_project": "plugin-apscheduler",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nonebot-plugin-apscheduler"
}
yanyongyu
Elapsed time: 0.31868s