besser-bot-framework


Namebesser-bot-framework JSON
Version 1.5.0 PyPI version JSON
download
home_pageNone
SummaryBESSER Bot Framework (BBF)
upload_time2024-11-13 13:01:32
maintainerNone
docs_urlNone
authorLuxembourg Institute of Science and Technology
requires_python>=3.10
licenseMIT
keywords bot framework chatbot state-machine nlp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <div align="center">
  <img src="./docs/source/_static/bbf_logo_readme.svg" alt="BESSER Bot Framework" width="500"/>
</div>

[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue?logo=python&logoColor=gold)](https://pypi.org/project/besser-bot-framework/)
[![PyPI version](https://img.shields.io/pypi/v/besser-bot-framework?logo=pypi&logoColor=white)](https://pypi.org/project/besser-bot-framework/)
[![PyPI - Downloads](https://static.pepy.tech/badge/besser-bot-framework)](https://pypi.org/project/besser-bot-framework/)
[![Documentation Status](https://readthedocs.org/projects/besser-bot-framework/badge/?version=latest)](https://besser-bot-framework.readthedocs.io/latest/?badge=latest)
[![PyPI - License](https://img.shields.io/pypi/l/besser-bot-framework)](https://opensource.org/license/MIT)
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-blue?logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/pireseduardo/)](https://www.linkedin.com/company/besser-bot-framework)
[![GitHub Repo stars](https://img.shields.io/github/stars/besser-pearl/besser-bot-framework?style=social)](https://star-history.com/#besser-pearl/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://besser-bot-framework.readthedocs.io/).**

## 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://besser-bot-framework.readthedocs.io/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://besser-bot-framework.readthedocs.io/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://besser-bot-framework.readthedocs.io/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://besser-bot-framework.readthedocs.io/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!

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "besser-bot-framework",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "bot, framework, chatbot, state-machine, nlp",
    "author": "Luxembourg Institute of Science and Technology",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e3/89/38ac589ae08a6449549fcf0583462d8c9d98ba7f1b4829e51b154d5b03ce/besser_bot_framework-1.5.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n  <img src=\"./docs/source/_static/bbf_logo_readme.svg\" alt=\"BESSER Bot Framework\" width=\"500\"/>\n</div>\n\n[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue?logo=python&logoColor=gold)](https://pypi.org/project/besser-bot-framework/)\n[![PyPI version](https://img.shields.io/pypi/v/besser-bot-framework?logo=pypi&logoColor=white)](https://pypi.org/project/besser-bot-framework/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/besser-bot-framework)](https://pypi.org/project/besser-bot-framework/)\n[![Documentation Status](https://readthedocs.org/projects/besser-bot-framework/badge/?version=latest)](https://besser-bot-framework.readthedocs.io/latest/?badge=latest)\n[![PyPI - License](https://img.shields.io/pypi/l/besser-bot-framework)](https://opensource.org/license/MIT)\n[![LinkedIn](https://img.shields.io/badge/-LinkedIn-blue?logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/pireseduardo/)](https://www.linkedin.com/company/besser-bot-framework)\n[![GitHub Repo stars](https://img.shields.io/github/stars/besser-pearl/besser-bot-framework?style=social)](https://star-history.com/#besser-pearl/besser-bot-framework)\n\nThe 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\nthe design and implementation of chatbots easier and accessible for everyone.\n\n**Check out the official [documentation](https://besser-bot-framework.readthedocs.io/).**\n\n## Quick start\n\n### Requirements\n\n- Python 3.11\n- Recommended: Create a virtual environment\n  (e.g. [venv](https://docs.python.org/3/library/venv.html),\n  [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html))\n- Install the [package](https://pypi.org/project/besser-bot-framework/):\n\n```bash\npip install besser-bot-framework\n```\nNote 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. \nIf you clone this project, installing the requirements from the requirements.txt file is enough.\n\n\n### Example bots\n\n- [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\n- [weather_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/weather_bot.py): Introducing [entities](https://besser-bot-framework.readthedocs.io/latest/wiki/core/entities.html)\n- [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://besser-bot-framework.readthedocs.io/latest/wiki/nlp/llm.html)\n- [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://besser-bot-framework.readthedocs.io/latest/wiki/nlp/rag.html)\n- [telegram_bot](https://github.com/BESSER-PEARL/BESSER-Bot-Framework/blob/main/besser/bot/test/examples/telegram_bot.py): Introducing the [TelegramPlatform](https://besser-bot-framework.readthedocs.io/latest/wiki/platforms/telegram_platform.html)\n\nFor more example bots, check out the [BBF-bot-examples](https://github.com/BESSER-PEARL/BBF-bot-examples) repository!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "BESSER Bot Framework (BBF)",
    "version": "1.5.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/BESSER-PEARL/BESSER-Bot-Framework/issues",
        "Documentation": "https://besser-bot-framework.readthedocs.io/",
        "Source Code": "https://github.com/BESSER-PEARL/BESSER-Bot-Framework"
    },
    "split_keywords": [
        "bot",
        " framework",
        " chatbot",
        " state-machine",
        " nlp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e9e20ec892d5dc806c256f47f1122a325cbbae8e7ae3d9215bf6568b804f60e",
                "md5": "48fed57897a1c7213ac7190fcc088a27",
                "sha256": "b7ed588833175687611a32b527f1c76b211f846ae56d687a2355e40d4e4a36f4"
            },
            "downloads": -1,
            "filename": "besser_bot_framework-1.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "48fed57897a1c7213ac7190fcc088a27",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 106255,
            "upload_time": "2024-11-13T13:01:31",
            "upload_time_iso_8601": "2024-11-13T13:01:31.010739Z",
            "url": "https://files.pythonhosted.org/packages/6e/9e/20ec892d5dc806c256f47f1122a325cbbae8e7ae3d9215bf6568b804f60e/besser_bot_framework-1.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e38938ac589ae08a6449549fcf0583462d8c9d98ba7f1b4829e51b154d5b03ce",
                "md5": "81cb9fb383f601b1d7d41b98a2fdb5a6",
                "sha256": "6ba12c368527479f238eb18f0d35e20e3cd3c6b65a63ca25b14e83cef39f955e"
            },
            "downloads": -1,
            "filename": "besser_bot_framework-1.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "81cb9fb383f601b1d7d41b98a2fdb5a6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 73004,
            "upload_time": "2024-11-13T13:01:32",
            "upload_time_iso_8601": "2024-11-13T13:01:32.439662Z",
            "url": "https://files.pythonhosted.org/packages/e3/89/38ac589ae08a6449549fcf0583462d8c9d98ba7f1b4829e51b154d5b03ce/besser_bot_framework-1.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 13:01:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BESSER-PEARL",
    "github_project": "BESSER-Bot-Framework",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "besser-bot-framework"
}
Luxembourg Institute of Science and Technology
Elapsed time: 0.84705s