https://github.com/GraiaProject/Ariadne

一个优雅且完备的 Python QQ 自动化框架，基于 Mirai API HTTP v2。 Powered by Graia Project.
https://github.com/GraiaProject/Ariadne

ariadne asyncio automation bot chatbot framework graia graiaproject mirai mirai-api-http python qq qqbot

Last synced: 5 months ago
JSON representation

一个优雅且完备的 Python QQ 自动化框架，基于 Mirai API HTTP v2。 Powered by Graia Project.

• Host: GitHub
• URL: https://github.com/GraiaProject/Ariadne
• Owner: GraiaProject
• License: agpl-3.0
• Created: 2021-10-16T15:53:38.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-07T20:50:15.000Z (7 months ago)
• Last Synced: 2024-11-10T09:41:04.074Z (6 months ago)
• Topics: ariadne, asyncio, automation, bot, chatbot, framework, graia, graiaproject, mirai, mirai-api-http, python, qq, qqbot
• Language: Python
• Homepage: https://graia.cn/ariadne
• Size: 3.5 MB
• Stars: 751
• Watchers: 6
• Forks: 45
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# 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/)|

|:-:|:-:|:-:|:-:|



**本项目适用于 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)