Metadata-Version: 2.4
Name: weavbot
Version: 0.4.0
Summary: A lightweight personal AI assistant framework
Author: weavbot contributors
License: MIT
License-File: LICENSE
Keywords: agent,ai,chatbot
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.13
Requires-Dist: anthropic>=0.84.0
Requires-Dist: chardet<6,>=3.0.2
Requires-Dist: croniter<7.0.0,>=6.0.0
Requires-Dist: dingtalk-stream<1.0.0,>=0.24.0
Requires-Dist: httpx<1.0.0,>=0.28.0
Requires-Dist: inquirerpy<1.0.0,>=0.3.4
Requires-Dist: json-repair<1.0.0,>=0.57.0
Requires-Dist: lark-oapi<2.0.0,>=1.5.0
Requires-Dist: loguru<1.0.0,>=0.7.3
Requires-Dist: markdownify<2.0.0,>=1.0.0
Requires-Dist: mcp<2.0.0,>=1.26.0
Requires-Dist: msgpack<2.0.0,>=1.1.0
Requires-Dist: openai>=2.8.0
Requires-Dist: prompt-toolkit<4.0.0,>=3.0.50
Requires-Dist: pydantic-settings<3.0.0,>=2.12.0
Requires-Dist: pydantic<3.0.0,>=2.12.0
Requires-Dist: python-socketio<6.0.0,>=5.16.0
Requires-Dist: python-socks[asyncio]<3.0.0,>=2.8.0
Requires-Dist: python-telegram-bot[socks]<23.0,>=22.0
Requires-Dist: qq-botpy<2.0.0,>=1.2.0
Requires-Dist: readability-lxml<1.0.0,>=0.8.4
Requires-Dist: rich<15.0.0,>=14.0.0
Requires-Dist: slack-sdk<4.0.0,>=3.39.0
Requires-Dist: slackify-markdown<1.0.0,>=0.2.0
Requires-Dist: socksio<2.0.0,>=1.0.0
Requires-Dist: typer<1.0.0,>=0.20.0
Requires-Dist: websocket-client<2.0.0,>=1.9.0
Requires-Dist: websockets<17.0,>=16.0
Provides-Extra: dev
Requires-Dist: pytest-asyncio<2.0.0,>=1.3.0; extra == 'dev'
Requires-Dist: pytest<10.0.0,>=9.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Description-Content-Type: text/markdown

# weavbot

[![GitHub Actions](https://github.com/yankeguo/weavbot/actions/workflows/ci.yml/badge.svg)](https://github.com/yankeguo/weavbot/actions)
[![PyPI](https://img.shields.io/pypi/v/weavbot)](https://pypi.org/project/weavbot/)
[![Docs (English)](https://img.shields.io/badge/docs-English-blue)](https://yankeguo.github.io/weavbot/en/)
[![Docs (中文)](https://img.shields.io/badge/文档-中文-blue)](https://yankeguo.github.io/weavbot/zh/)

A lightweight personal AI assistant framework.

[中文说明](./README.zh.md)

## Installation

```bash
uv tool install weavbot
```

Verify:

```bash
weavbot --version
```

To try the latest unreleased features:

```bash
uv tool install git+https://github.com/yankeguo/weavbot.git
```

## Onboard (Recommended First Run)

Initialize local config/workspace and run the interactive setup wizard:

```bash
weavbot onboard
```

What `onboard` does:

- Creates `~/.weavbot/config.json` and `~/.weavbot/workspace/`
- Guides provider/model selection with realtime filtering
- Configures one chat channel in the wizard (Telegram/Discord/Feishu/DingTalk/Slack/QQ/Wecom/Email/Mochat)
- Offers optional `ripgrep` install and gateway auto-start setup

For non-interactive or scripted setup, use repeatable `--set key=value`:

```bash
weavbot onboard \
  --set providers.openrouter.apiKey=sk-or-v1-xxx \
  --set providers.openrouter.apiBase=https://openrouter.ai/api/v1 \
  --set agents.defaults.provider=openrouter \
  --set agents.defaults.model=openai/gpt-4o-mini
```

Detailed CLI docs:
- English: [CLI Reference](https://yankeguo.github.io/weavbot/en/cli/)
- 中文: [命令参考](https://yankeguo.github.io/weavbot/zh/cli/)

**Full documentation:** [https://yankeguo.github.io/weavbot/](https://yankeguo.github.io/weavbot/)

## Wechat Channel

Wechat is configured in two phases:

1. Enable it in config (interactive `onboard` only sets placeholder enablement):
   - `channels.wechat.enabled=true`
2. Complete QR login and credential binding with:

```bash
weavbot wechat login
```

For multi-account setups, put account entries under `channels.wechat.accounts` and optionally limit runtime accounts with `channels.wechat.enabledAccounts`.

Configuration reference:

- English: [Wechat config](https://yankeguo.github.io/weavbot/en/configuration/#channelswechat)
- 中文: [微信配置](https://yankeguo.github.io/weavbot/zh/configuration/#channelswechat)

## Credits

This project is a hard fork of [nanobot](https://github.com/HKUDS/nanobot) by [HKUDS](https://github.com/HKUDS), with significant optimizations and improvements.

## License

MIT
