Metadata-Version: 2.1
Name: besser-bot-framework
Version: 1.3.0
Summary: BESSER Bot Framework (BBF)
Author: Luxembourg Institute of Science and Technology
License: MIT
Project-URL: Documentation, https://besserbot-framework.readthedocs.io/
Project-URL: Source Code, https://github.com/BESSER-PEARL/BESSER-Bot-Framework
Project-URL: Bug Tracker, https://github.com/BESSER-PEARL/BESSER-Bot-Framework/issues
Keywords: bot,framework,chatbot,state-machine,nlp
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: audio-recorder-streamlit==0.0.8
Requires-Dist: chromadb==0.5.4
Requires-Dist: dateparser==1.1.8
Requires-Dist: keras==2.14.0
Requires-Dist: langchain==0.2.9
Requires-Dist: langchain-community==0.2.7
Requires-Dist: librosa==0.10.1
Requires-Dist: nltk==3.8.1
Requires-Dist: numpy==1.26.1
Requires-Dist: openai==1.24.0
Requires-Dist: pandas==2.1.1
Requires-Dist: plotly==5.18.0
Requires-Dist: psycopg2-binary==2.9.9
Requires-Dist: pypdf==4.3.1
Requires-Dist: python-telegram-bot==21.0
Requires-Dist: replicate==0.23.1
Requires-Dist: requests==2.31.0
Requires-Dist: snowballstemmer==2.2.0
Requires-Dist: spacy==3.7.2
Requires-Dist: SpeechRecognition==3.10.0
Requires-Dist: sqlalchemy==2.0.29
Requires-Dist: streamlit==1.27.2
Requires-Dist: tensorflow==2.14.0
Requires-Dist: text2num==2.5.0
Requires-Dist: tiktoken==0.7.0
Requires-Dist: transformers==4.41.1
Requires-Dist: websocket-client==1.6.4
Requires-Dist: websockets==11.0.3
Requires-Dist: streamlit-antd-components==0.3.2
Requires-Dist: pyvis==0.3.2
Requires-Dist: torch==2.3.1

# BESSER Bot Framework

The BESSER Bot Framework (BBF) is part of the [BESSER](https://modeling-languages.com/a-smart-low-code-platform-for-smart-software-in-luxembourg-goodbye-barcelona/) (Building Better Smart Software Faster) project. It aims to make
the design and implementation of chatbots easier and accessible for everyone.

**Check out the official [documentation](https://besserbot-framework.readthedocs.io/en/latest/).**

## Quick start

### Requirements

- Python 3.11
- Recommended: Create a virtual environment
  (e.g. [venv](https://docs.python.org/3/library/venv.html),
  [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html))
- Install the [package](https://pypi.org/project/besser-bot-framework/):

```bash
pip install besser-bot-framework
```
Note that if you want to set your bot's language to Luxembourgish and are using the package installed with pip, you will need to manually install the [spellux](https://github.com/questoph/spellux) library. 
If you clone this project, installing the requirements from the requirements.txt file is enough.


### Example bots

- [greetings_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/greetings_bot.py): Very simple bot for the first contact with the framework
- [weather_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/weather_bot.py): Introducing [entities](https://besserbot-framework.readthedocs.io/en/latest/wiki/core/entities.html)
- [llm_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/llm_bot.py): Introducing [Large Language Models (LLMs)](https://besserbot-framework.readthedocs.io/en/latest/wiki/nlp/llm.html)
- [rag_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/rag_bot.py): Introducing [Retrieval Augmented Generation (RAG)](https://besserbot-framework.readthedocs.io/en/latest/wiki/nlp/rag.html)
- [telegram_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/telegram_bot.py): Introducing the [TelegramPlatform](https://besserbot-framework.readthedocs.io/en/latest/wiki/platforms/telegram_platform.html)

For more example bots, check out the [BBF-bot-examples](https://github.com/BESSER-PEARL/BBF-bot-examples) repository!
