# breadAI

**Repository Path**: wrp142536/breadAI

## Basic Information

- **Project Name**: breadAI
- **Description**: 小面包人工智能（Bread-AI）是一个纯 Python 写的聊天机器人，基于微信公众号平台，开放源代码和语料库
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 11
- **Created**: 2018-07-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Breadbot

## Overview
* Breadbot is a simple and powerful chatbot
  * Easy to deploy
  * More than 1000,000 corpus
  * Fast response
  * No database
  * Based on Python3
  * Support WeChat

## Have a try
* Download WeChat on your phone
* Login WeChat and scan the QR code
* ![QR](QR.jpg)
* Talk to Breadbot

## Install
Breadbot works on Linux. Ofcause u can let it work on other OS by modify the source code.
* Download
  * `git clone https://github.com/ideamark/breadbot`
* Install
  * First, make sure you have installed python3 and python3-pip
  * run setup command: `python3 setup.py install`
  * The setup will download corpus from ideamark.github.io
* Uninstall
  * `python3 setup.py uninstall`
* Clean (not uninstall)
  * `python3 setup.py clean`

## Corpus
* All the corpus of Breadbot is on [ideamark.github.io](https://ideamark.github.io). It is a website and also a git repo.
* The repo will be downloaded automatically when you setup Breadbot by `python3 setup.py install`.
* Or u can download it manually by `git clone https://github.com/ideamark/ideamark.github.io`

## Config
* Just watch the only single config file: [bread.cfg](etc/bread.cfg)

## Console
* Type command `breadbot` to launch the local console.
* Then u can test Bread, or run commands on this console, type `help` for more info.

## Super user mode
* Super user mode is set for developers.
* The local console is default set as super user.
* If your ID is in bread.cfg super user list, u will get the super user functions.

## Connect to WeChat
* Config your WeChat public platform account on [mp.weixin.qq.com](https://mp.weixin.qq.com), create the token and enter your url.
* Run the command `breadbot start`, enter your token and ip.
* After that, Breadbot will connect to WeChat public platform and u can chat to it on WeChat.

## Seek more
* Author: Mark Young
* Email: ideamark@qq.com