---
title: Edu Assistant
emoji: 🐶
colorFrom: pink
colorTo: blue
sdk: gradio
sdk_version: 3.37.0
app_file: webui/ui.py
fullWidth: true
pinned: false
license: mit
app_port: 7860
---

# Edu Assistant

[![Checkstyle](https://github.com/Arcadia822/codedog/actions/workflows/flake8.yml/badge.svg)](https://github.com/codedog-ai/edu-assistant/actions/workflows/flake8.yml)
[![Pytest](https://github.com/Arcadia822/codedog/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/codedog-ai/edu-assistant/actions/workflows/test.yml)
[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Arcadia822/ce38dae58995aeffef42065093fcfe84/raw/edu_assistant_master.json)](https://github.com/codedog-ai/edu-assistant/actions/workflows/test.yml)

## config

| Environment Variable          | Necessary | Default   | Description                              |
| ----------------------------- | --------- | --------- | ---------------------------------------- |
| CODEDOG_SERVER                | No        | 0.0.0.0   | Server address                           |
| CODEDOG_PORT                  | No        | 32167     | Server port                              |
| CODEDOG_WORKER_NUM            | No        | 1         | Server worker number                     |
| OPENAI_API_KEY                | Yes       |           | Api Key for calling openai api           |
| OPENAI_PROXY                  | No        |           | openai proxy                             |
| AZURE_OPENAI                  | No        |           | use azure openai if not blank            |
| AZURE_OPENAI_API_KEY          | No        |           | azure openai api key                     |
| AZURE_OPENAI_API_BASE         | No        |           | azure openai api base                    |
| AZURE_OPENAI_DEPLOYMENT_ID    | No        |           | azure openai deployment id for gpt 3.5   |
| AZURE_OPENAI_EMBEDDING_DEP_ID | No        |           | azure openai deployment id for embedding |
| QDRANT_API                    | No        |           | use qdrant api if not blank              |
| QDRANT_API_KEY                | No        |           | qdrant api key                           |
| QDRANT_API_BASE               | No        |           | qdrant api base                          |
| REDIS_HOST                    | No        | 127.0.0.1 | redis host. used for orm                 |
| REDIS_PORT                    | No        | 6379      | redis port                               |
| REDIS_PASSWORD                | No        |           | redis password                           |
| REDIS_SSL                     | No        |           | connect use ssl if not blank             |
| WECHAT_TOKEN                  | No        |           | wechat token                             |
| WECHAT_AESKEY                 | No        |           | wechat aeskey                            |
| WECHAT_COPRID                 | No        |           | wechat corpid                            |
| WECHAT_SECRET                 | No        |           | wechat secret                            |

## setup

- install python 3.10+
- install poetry 1.5.1+
- run: `poetry install --with dev`


# How to start wechat-server
- python3 wechat-server/web.py