LangBot/README.md at e642ffa5b31709468bb69d17c17c5eb28ea870a7

opensource/LangBot

Fork 0

mirror of https://github.com/langbot-app/LangBot.git synced 2026-10-31 02:38:21 +08:00

Files

T

e642ffa5b3 chore: Add PyPI package support for uvx/pip installation (#1764 )

* Initial plan

* Add package structure and resource path utilities

- Created langbot/ package with __init__.py and __main__.py entry point
- Added paths utility to find frontend and resource files from package installation
- Updated config loading to use resource paths
- Updated frontend serving to use resource paths
- Added MANIFEST.in for package data inclusion
- Updated pyproject.toml with build system and entry points

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Add PyPI publishing workflow and update license

- Created GitHub Actions workflow to build frontend and publish to PyPI
- Added license field to pyproject.toml to fix deprecation warning
- Updated .gitignore to exclude build artifacts
- Tested package building successfully

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Add PyPI installation documentation

- Created PYPI_INSTALLATION.md with detailed installation and usage instructions
- Updated README.md to feature uvx/pip installation as recommended method
- Updated README_EN.md with same changes for English documentation

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Address code review feedback

- Made package-data configuration more specific to langbot package only
- Improved path detection with caching to avoid repeated file I/O
- Removed sys.path searching which was incorrect for package data
- Removed interactive input() call for non-interactive environment compatibility
- Simplified error messages for version check

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Fix code review issues

- Use specific exception types instead of bare except
- Fix misleading comments about directory levels
- Remove redundant existence check before makedirs with exist_ok=True
- Use context manager for file opening to ensure proper cleanup

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* Simplify package configuration and document behavioral differences

- Removed redundant package-data configuration, relying on MANIFEST.in
- Added documentation about behavioral differences between package and source installation
- Clarified that include-package-data=true uses MANIFEST.in for data files

Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>

* chore: update pyproject.toml

* chore: try pack templates in langbot/

* chore: update

* chore: update

* chore: update

* chore: update

* chore: update

* chore: adjust dir structure

* chore: fix imports

* fix: read default-pipeline-config.json

* fix: read default-pipeline-config.json

* fix: tests

* ci: publish pypi

* chore: bump version 4.6.0-beta.1 for testing

* chore: add templates/**

* fix: send adapters and requesters icons

* chore: bump version 4.6.0b2 for testing

* chore: add platform field for docker-compose.yaml

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com>
Co-authored-by: Junyan Qin <rockchinq@gmail.com>

2025-11-16 19:53:01 +08:00

8.0 KiB

Raw Blame History

English / 简体中文 / 繁體中文 / 日本語 / (PR for your language)

项目主页｜部署文档｜插件介绍｜提交插件

LangBot 是一个开源的大语言模型原生即时通信机器人开发平台，旨在提供开箱即用的 IM 机器人开发体验，具有 Agent、RAG、MCP 等多种 LLM 应用功能，适配全球主流即时通信平台，并提供丰富的 API 接口，支持自定义开发。

📦 开始使用

快速体验（推荐）

使用 uvx 一键启动（无需安装）：

uvx langbot

或使用 pip 安装后运行：

pip install langbot
langbot

访问 http://localhost:5300 即可开始使用。

详细文档PyPI 安装。

Docker Compose 部署

git clone https://github.com/langbot-app/LangBot
cd LangBot/docker
docker compose up -d

访问 http://localhost:5300 即可开始使用。

详细文档Docker 部署。

宝塔面板部署

已上架宝塔面板，若您已安装宝塔面板，可以根据文档使用。

Zeabur 云部署

社区贡献的 Zeabur 模板。

Railway 云部署

手动部署

直接使用发行版运行，查看文档手动部署。

Kubernetes 部署

参考 Kubernetes 部署文档。

😎 保持更新

点击仓库右上角 Star 和 Watch 按钮，获取最新动态。

✨ 特性

💬 大模型对话、Agent：支持多种大模型，适配群聊和私聊；具有多轮对话、工具调用、多模态、流式输出能力，自带 RAG（知识库）实现，并深度适配 Dify。
🤖 多平台支持：目前支持 QQ、QQ频道、企业微信、个人微信、飞书、Discord、Telegram 等平台。
🛠️ 高稳定性、功能完备：原生支持访问控制、限速、敏感词过滤等机制；配置简单，支持多种部署方式。支持多流水线配置，不同机器人用于不同应用场景。
🧩 插件扩展、活跃社区：支持事件驱动、组件扩展等插件机制；适配 Anthropic MCP 协议；目前已有数百个插件。
😻 Web 管理面板：支持通过浏览器管理 LangBot 实例，不再需要手动编写配置文件。

详细规格特性请访问文档。

或访问 demo 环境：https://demo.langbot.dev/

登录信息：邮箱：demo@langbot.app 密码：langbot123456
注意：仅展示 WebUI 效果，公开环境，请不要在其中填入您的任何敏感信息。

消息平台

平台	状态	备注
QQ 个人号	✅	QQ 个人号私聊、群聊
QQ 官方机器人	✅	QQ 官方机器人，支持频道、私聊、群聊
企业微信	✅
企微对外客服	✅
企微智能机器人	✅
个人微信	✅
微信公众号	✅
飞书	✅
钉钉	✅
Discord	✅
Telegram	✅
Slack	✅
LINE	✅

大模型能力

模型	状态	备注
OpenAI	✅	可接入任何 OpenAI 接口格式模型
DeepSeek	✅
Moonshot	✅
Anthropic	✅
xAI	✅
智谱AI	✅
胜算云	✅	全球大模型都可调用（友情推荐）
优云智算	✅	大模型和 GPU 资源平台
PPIO	✅	大模型和 GPU 资源平台
接口 AI	✅	大模型聚合平台，专注全球大模型接入
302.AI	✅	大模型聚合平台
Google Gemini	✅
Dify	✅	LLMOps 平台
Ollama	✅	本地大模型运行平台
LMStudio	✅	本地大模型运行平台
GiteeAI	✅	大模型接口聚合平台
SiliconFlow	✅	大模型聚合平台
小马算力	✅	大模型聚合平台
阿里云百炼	✅	大模型聚合平台, LLMOps 平台
火山方舟	✅	大模型聚合平台, LLMOps 平台
ModelScope	✅	大模型聚合平台
MCP	✅	支持通过 MCP 协议获取工具
百宝箱Tbox	✅	蚂蚁百宝箱智能体平台，每月免费10亿大模型Token

TTS

平台/模型	备注
FishAudio	插件
海豚 AI	插件
AzureTTS	插件

文生图

平台/模型	备注
阿里云百炼	插件

😘 社区贡献

感谢以下代码贡献者和社区里其他成员对 LangBot 的贡献：

8.0 KiB Raw Blame History Unescape Escape