Skip to main content

A bot powered by NoneBot2

Project description

PROJ.Amrita 🌸 - 基于 NoneBot 的 LLM 聊天机器人框架

Python License NoneBot

Amrita 是一个基于NoneBot2的强大聊天机器人框架,专为快速构建和部署智能聊天机器人而设计。它不仅是一个 CLI 工具,更是一个完整的 LLM 聊天机器人解决方案,支持多种大语言模型和适配器。

🌟 特性亮点

  • 多模型支持: 支持 OpenAI、DeepSeek、Gemini 等多种大语言模型
  • 多模态能力: 支持处理图像等多媒体内容
  • 灵活适配: 原生支持 Onebot-V11 协议,轻松对接 QQ 等平台
  • 智能会话管理: 内置会话控制和历史记录管理
  • 插件化架构: 模块化设计,易于扩展和定制
  • 开箱即用: 预设丰富的回复模板和功能配置
  • 强大 CLI 工具: 一体化命令行管理工具,简化开发和部署流程

🚀 快速开始

安装

# 使用pip安装
pip install amrita

# 或者使用uv安装(推荐)
uv pip install amrita

创建项目

# 创建新项目
amrita create mybot

# 进入项目目录
cd mybot

# 启动机器人
amrita run

初始化现有项目

# 在当前目录初始化项目
amrita init

# 启动机器人
amrita run

🧠 核心功能

LLM 聊天插件

Amrita 内置了 SuggarChat 插件,基于 SuggarChat 的 LLM 模型,提供智能聊天功能。详见 SuggarChat 的文档

📦 依赖管理

Amrita 使用uv进行依赖管理,提供两种安装模式:

# 基础安装(包含CLI)
pip install amrita

# 完整安装(包含完整的运行依赖)
pip install amrita[full]

🛠️ CLI 命令

命令 描述
amrita create 创建新项目
amrita init 初始化当前目录为项目
amrita run 运行项目
amrita version 查看版本信息
amrita check-dependencies 检查依赖
amrita proj-info 显示项目信息
amrita nb 直接运行 nb-cli 命令
amrita entry 生成入口文件

🧩 插件系统

Amrita 插件系统基于 NoneBot2 的插件系统,允许用户扩展 Amrita 的功能,内置了一些常用插件,如 LitePerm权限管理插件,以及 AMenu 菜单插件(这个还没写)。

⚙️ 配置文件

通常来说,配置文件位于项目根目录下的 config 文件夹中,此外您仍需要配置DOTENV文件,用于配置环境变量(位于机器人目录的.env)。

以下是Amrita的独有配置项

LOG_DIR=logs # 日志目录
ADMIN_GROUP=1233456789 # 管理员群组ID,必配,推送Bot错误日志及其他信息
DISABLED_BUILTIN_PLUGINS=[] # 禁用的内置插件 注意:如果其他插件有依赖此插件,那么它仍然会被加载。
AMRITA_LOG_LEVEL=WARNING # 记录到文件的日志等级
BOT_NAME=Amrita # 为你的机器人名称
RATE_LIMIT=5 # 聊天频率限制(秒)

📚 文档和资源

🤝 贡献

欢迎提交 Issue 和 Pull Request 来帮助改进 Amrita!

📄 许可证

本项目采用 GPL-3.0 许可证,详见LICENSE文件。

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amrita-0.1.2.tar.gz (92.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

amrita-0.1.2-py3-none-any.whl (126.1 kB view details)

Uploaded Python 3

File details

Details for the file amrita-0.1.2.tar.gz.

File metadata

  • Download URL: amrita-0.1.2.tar.gz
  • Upload date:
  • Size: 92.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for amrita-0.1.2.tar.gz
Algorithm Hash digest
SHA256 743cbd9b8e245d90c6fdc6ae473287641cfcb8c9105071198f6c7c178e0662d8
MD5 ab8658e285c473df88924bb5f952f15a
BLAKE2b-256 5b75d52999f02918a7c4125ffdf9955d1993cb136e6e20d4ae089b1c2280c87b

See more details on using hashes here.

File details

Details for the file amrita-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: amrita-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 126.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for amrita-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2642abc9a749c6dec62634c38e6eb0184ae72b976edf0a7bf806bf276390fd88
MD5 71a625e8085c63119f62bb7c2471fbb1
BLAKE2b-256 7ba38b9b8187d92d5b9c452518d2adfb23d8607c363dfb303a744b1315edb169

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page