graia-ariadne

Name	graia-ariadne JSON
Version	0.11.7 JSON
	download
home_page
Summary	Another elegant Python QQ Bot framework for mirai and mirai-api-http v2.
upload_time	2023-08-05 15:23:57
maintainer
docs_url	None
author
requires_python	<4.0,>=3.8
license
keywords	graia bot qq framework mirai ariadne
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <div align="center">

# Ariadne

_Another elegant framework for mirai and mirai-api-http v2._

> 接受当下, 面向未来.

[![PyPI](https://img.shields.io/pypi/v/graia-ariadne)](https://pypi.org/project/graia-ariadne)
[![Python Version](https://img.shields.io/pypi/pyversions/graia-ariadne)](https://pypi.org/project/graia-ariadne)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![License](https://img.shields.io/github/license/GraiaProject/Ariadne)](https://github.com/GraiaProject/Ariadne/blob/master/LICENSE)
[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)

|文档|[![docs](https://img.shields.io/badge/readthedocs-gray)](https://graia.readthedocs.io/)|[![docs](https://img.shields.io/badge/netlify-28afa0)](https://graia.netlify.app/)|[![docs](https://img.shields.io/badge/cloudflare-orange)](https://graia.pages.dev/)|
|:-:|:-:|:-:|:-:|

|API 参考|[![docs](https://img.shields.io/badge/readthedocs-gray)](https://graia.readthedocs.io/projects/ariadne)|[![docs](https://img.shields.io/badge/netlify-28afa0)](https://graia-ariadne.netlify.app/)|[![docs](https://img.shields.io/badge/cloudflare-orange)](https://graia-ariadne.pages.dev/)|
|:-:|:-:|:-:|:-:|


</div>

**本项目适用于 mirai-api-http 2.0 以上版本**.

Ariadne 是 `Graia Project` 继承了 [`Application`](https://github.com/GraiaProject/Application) 并进行了许多改进后产生的作品,
相信它可以给你带来良好的 `Python QQ Bot` 开发体验.

**注意, 本框架需要 [`mirai-api-http v2`](https://github.com/project-mirai/mirai-api-http).**

## 安装

`pdm add graia-ariadne`

或

`poetry add graia-ariadne`

或

`pip install graia-ariadne`

> 我们强烈建议使用 [`pdm`](https://pdm.fming.dev) / [`poetry`](https://python-poetry.org) 进行包管理

## 开始使用

```python
from graia.ariadne.app import Ariadne
from graia.ariadne.connection.config import config
from graia.ariadne.model import Friend

app = Ariadne(config(verify_key="ServiceVerifyKey", account=123456789))


@app.broadcast.receiver("FriendMessage")
async def friend_message_listener(app: Ariadne, friend: Friend):
    await app.send_message(friend, "Hello, World!")


Ariadne.launch_blocking()
```

更多信息请看
[![快速开始](https://img.shields.io/badge/文档-快速开始-blue)](https://graia.readthedocs.io/ariadne/quickstart/)

## 讨论

QQ 交流群: [邀请链接](https://jq.qq.com/?_wv=1027&k=VXp6plBD)

> QQ 群不定时清除不活跃成员, 请自行重新申请入群.

## 文档

[![API 文档](https://img.shields.io/badge/API_文档-here-purple)](https://graia.readthedocs.io/projects/ariadne/)
[![官方文档](https://img.shields.io/badge/官方文档-here-blue)](https://graia.readthedocs.io/ariadne/)
[![社区文档](https://img.shields.io/badge/社区文档-here-pink)](https://graiax.cn)
[![鸣谢](https://img.shields.io/badge/鸣谢-here-lightgreen)](https://graia.readthedocs.io/ariadne/appendix/credits)

**如果认为本项目有帮助, 欢迎点一个 `Star`.**

## 协议

本项目以 [`GNU AGPL-3.0`](https://choosealicense.com/licenses/agpl-3.0/) 作为开源协议, 这意味着你需要遵守相应的规则.

## 持续集成 (CI) 状态

[![API Doc Status](https://readthedocs.org/projects/graia-ariadne/badge/?version=latest)](https://graia.readthedocs.io/projects/ariadne/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/GraiaProject/Ariadne/master.svg)](https://results.pre-commit.ci/latest/github/GraiaProject/Ariadne/master)

[![API 文档构建](https://github.com/GraiaProject/Ariadne/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/GraiaProject/Ariadne/actions/workflows/deploy-docs.yml)
[![发布](https://github.com/GraiaProject/Ariadne/actions/workflows/release.yml/badge.svg)](https://github.com/GraiaProject/Ariadne/actions/workflows/release.yml)

## 参与开发

[贡献指南](./CONTRIBUTING.md)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "graia-ariadne",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": "",
    "keywords": "graia bot qq framework mirai ariadne",
    "author": "",
    "author_email": "BlueGlassBlock <blueglassblock@outlook.com>, GreyElaina <GreyElaina@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/d8/05/44865a1ea93c7502685b467c3c0a20565342f68f8c1e31c3112f09764c88/graia_ariadne-0.11.7.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n\n# Ariadne\n\n_Another elegant framework for mirai and mirai-api-http v2._\n\n> \u63a5\u53d7\u5f53\u4e0b, \u9762\u5411\u672a\u6765.\n\n[![PyPI](https://img.shields.io/pypi/v/graia-ariadne)](https://pypi.org/project/graia-ariadne)\n[![Python Version](https://img.shields.io/pypi/pyversions/graia-ariadne)](https://pypi.org/project/graia-ariadne)\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![License](https://img.shields.io/github/license/GraiaProject/Ariadne)](https://github.com/GraiaProject/Ariadne/blob/master/LICENSE)\n[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)\n\n|\u6587\u6863|[![docs](https://img.shields.io/badge/readthedocs-gray)](https://graia.readthedocs.io/)|[![docs](https://img.shields.io/badge/netlify-28afa0)](https://graia.netlify.app/)|[![docs](https://img.shields.io/badge/cloudflare-orange)](https://graia.pages.dev/)|\n|:-:|:-:|:-:|:-:|\n\n|API \u53c2\u8003|[![docs](https://img.shields.io/badge/readthedocs-gray)](https://graia.readthedocs.io/projects/ariadne)|[![docs](https://img.shields.io/badge/netlify-28afa0)](https://graia-ariadne.netlify.app/)|[![docs](https://img.shields.io/badge/cloudflare-orange)](https://graia-ariadne.pages.dev/)|\n|:-:|:-:|:-:|:-:|\n\n\n</div>\n\n**\u672c\u9879\u76ee\u9002\u7528\u4e8e mirai-api-http 2.0 \u4ee5\u4e0a\u7248\u672c**.\n\nAriadne \u662f `Graia Project` \u7ee7\u627f\u4e86 [`Application`](https://github.com/GraiaProject/Application) \u5e76\u8fdb\u884c\u4e86\u8bb8\u591a\u6539\u8fdb\u540e\u4ea7\u751f\u7684\u4f5c\u54c1,\n\u76f8\u4fe1\u5b83\u53ef\u4ee5\u7ed9\u4f60\u5e26\u6765\u826f\u597d\u7684 `Python QQ Bot` \u5f00\u53d1\u4f53\u9a8c.\n\n**\u6ce8\u610f, \u672c\u6846\u67b6\u9700\u8981 [`mirai-api-http v2`](https://github.com/project-mirai/mirai-api-http).**\n\n## \u5b89\u88c5\n\n`pdm add graia-ariadne`\n\n\u6216\n\n`poetry add graia-ariadne`\n\n\u6216\n\n`pip install graia-ariadne`\n\n> \u6211\u4eec\u5f3a\u70c8\u5efa\u8bae\u4f7f\u7528 [`pdm`](https://pdm.fming.dev) / [`poetry`](https://python-poetry.org) \u8fdb\u884c\u5305\u7ba1\u7406\n\n## \u5f00\u59cb\u4f7f\u7528\n\n```python\nfrom graia.ariadne.app import Ariadne\nfrom graia.ariadne.connection.config import config\nfrom graia.ariadne.model import Friend\n\napp = Ariadne(config(verify_key=\"ServiceVerifyKey\", account=123456789))\n\n\n@app.broadcast.receiver(\"FriendMessage\")\nasync def friend_message_listener(app: Ariadne, friend: Friend):\n    await app.send_message(friend, \"Hello, World!\")\n\n\nAriadne.launch_blocking()\n```\n\n\u66f4\u591a\u4fe1\u606f\u8bf7\u770b\n[![\u5feb\u901f\u5f00\u59cb](https://img.shields.io/badge/\u6587\u6863-\u5feb\u901f\u5f00\u59cb-blue)](https://graia.readthedocs.io/ariadne/quickstart/)\n\n## \u8ba8\u8bba\n\nQQ \u4ea4\u6d41\u7fa4: [\u9080\u8bf7\u94fe\u63a5](https://jq.qq.com/?_wv=1027&k=VXp6plBD)\n\n> QQ \u7fa4\u4e0d\u5b9a\u65f6\u6e05\u9664\u4e0d\u6d3b\u8dc3\u6210\u5458, \u8bf7\u81ea\u884c\u91cd\u65b0\u7533\u8bf7\u5165\u7fa4.\n\n## \u6587\u6863\n\n[![API \u6587\u6863](https://img.shields.io/badge/API_\u6587\u6863-here-purple)](https://graia.readthedocs.io/projects/ariadne/)\n[![\u5b98\u65b9\u6587\u6863](https://img.shields.io/badge/\u5b98\u65b9\u6587\u6863-here-blue)](https://graia.readthedocs.io/ariadne/)\n[![\u793e\u533a\u6587\u6863](https://img.shields.io/badge/\u793e\u533a\u6587\u6863-here-pink)](https://graiax.cn)\n[![\u9e23\u8c22](https://img.shields.io/badge/\u9e23\u8c22-here-lightgreen)](https://graia.readthedocs.io/ariadne/appendix/credits)\n\n**\u5982\u679c\u8ba4\u4e3a\u672c\u9879\u76ee\u6709\u5e2e\u52a9, \u6b22\u8fce\u70b9\u4e00\u4e2a `Star`.**\n\n## \u534f\u8bae\n\n\u672c\u9879\u76ee\u4ee5 [`GNU AGPL-3.0`](https://choosealicense.com/licenses/agpl-3.0/) \u4f5c\u4e3a\u5f00\u6e90\u534f\u8bae, \u8fd9\u610f\u5473\u7740\u4f60\u9700\u8981\u9075\u5b88\u76f8\u5e94\u7684\u89c4\u5219.\n\n## \u6301\u7eed\u96c6\u6210 (CI) \u72b6\u6001\n\n[![API Doc Status](https://readthedocs.org/projects/graia-ariadne/badge/?version=latest)](https://graia.readthedocs.io/projects/ariadne/)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/GraiaProject/Ariadne/master.svg)](https://results.pre-commit.ci/latest/github/GraiaProject/Ariadne/master)\n\n[![API \u6587\u6863\u6784\u5efa](https://github.com/GraiaProject/Ariadne/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/GraiaProject/Ariadne/actions/workflows/deploy-docs.yml)\n[![\u53d1\u5e03](https://github.com/GraiaProject/Ariadne/actions/workflows/release.yml/badge.svg)](https://github.com/GraiaProject/Ariadne/actions/workflows/release.yml)\n\n## \u53c2\u4e0e\u5f00\u53d1\n\n[\u8d21\u732e\u6307\u5357](./CONTRIBUTING.md)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Another elegant Python QQ Bot framework for mirai and mirai-api-http v2.",
    "version": "0.11.7",
    "project_urls": {
        "Documentation": "https://graia.readthedocs.io/projects/ariadne",
        "Repository": "https://github.com/GraiaProject/Ariadne"
    },
    "split_keywords": [
        "graia",
        "bot",
        "qq",
        "framework",
        "mirai",
        "ariadne"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8956fa49d564df405c94fa40c75bc273aff94a1ea446cb27e2509a7069a07fb9",
                "md5": "7b2830093d026b6865b7148944ca5530",
                "sha256": "151840a25348d092108c03363e93e915c17bab15a15772af097b38740cce55fa"
            },
            "downloads": -1,
            "filename": "graia_ariadne-0.11.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7b2830093d026b6865b7148944ca5530",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 125151,
            "upload_time": "2023-08-05T15:23:55",
            "upload_time_iso_8601": "2023-08-05T15:23:55.157582Z",
            "url": "https://files.pythonhosted.org/packages/89/56/fa49d564df405c94fa40c75bc273aff94a1ea446cb27e2509a7069a07fb9/graia_ariadne-0.11.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d80544865a1ea93c7502685b467c3c0a20565342f68f8c1e31c3112f09764c88",
                "md5": "cf0f1598b06f3c85f72ddf548f1a3c67",
                "sha256": "fa2e964e7e0178299da9890350c14e5932212fc9083c8a78195d4738a3c9f2ed"
            },
            "downloads": -1,
            "filename": "graia_ariadne-0.11.7.tar.gz",
            "has_sig": false,
            "md5_digest": "cf0f1598b06f3c85f72ddf548f1a3c67",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 105371,
            "upload_time": "2023-08-05T15:23:57",
            "upload_time_iso_8601": "2023-08-05T15:23:57.321826Z",
            "url": "https://files.pythonhosted.org/packages/d8/05/44865a1ea93c7502685b467c3c0a20565342f68f8c1e31c3112f09764c88/graia_ariadne-0.11.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-05 15:23:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GraiaProject",
    "github_project": "Ariadne",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "graia-ariadne"
}