Metadata-Version: 2.1
Name: edubot
Version: 0.3.0
Summary: 
License: GPLv3
Author: exciteabletom
Author-email: tom@digitalnook.net
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: openai (>=0.25.0,<0.26.0)
Requires-Dist: sqlalchemy[mypy] (>=1.4.44,<1.5.0)
Description-Content-Type: text/markdown

# Edubot

An AI-based bot (currently using GPT-3) designed to be used in various environment (Matrix, Mastodon, etc).

The Edubot, as the name suggests, focussed on use in educational environments:
  1. It is intended to be educational, with a customisable personality for your context.
  1. It can learn from interaction with users.
  
Edubot is the first project from Open EdTech  https://openedtech.global 


## Dev environment quickstart
1. Install [Poetry](https://python-poetry.org/docs/)
1. Install dependencies: `poetry install`
1. Activate the env: `poetry shell`
1. Install pre-commit hooks: `pre-commit install`
1. Copy SAMPLE_CONFIG.ini and put your information in
1. Set the `EDUBOT_CONFIG` env variable to wherever you put your config.

