besser-agentic-framework


Namebesser-agentic-framework JSON
Version 2.0.0 PyPI version JSON
download
home_pageNone
SummaryBESSER Agentic Framework (BAF)
upload_time2025-01-14 16:32:28
maintainerNone
docs_urlNone
authorLuxembourg Institute of Science and Technology
requires_python>=3.10
licenseMIT
keywords agent 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/baf_logo_readme.svg" alt="BESSER Agentic 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-agentic-framework/)
[![PyPI version](https://img.shields.io/pypi/v/besser-agentic-framework?logo=pypi&logoColor=white)](https://pypi.org/project/besser-agentic-framework/)
[![PyPI - Downloads](https://static.pepy.tech/badge/besser-agentic-framework)](https://pypi.org/project/besser-agentic-framework/)
[![Documentation Status](https://readthedocs.org/projects/besser-agentic-framework/badge/?version=latest)](https://besser-agentic-framework.readthedocs.io/latest/?badge=latest)
[![PyPI - License](https://img.shields.io/pypi/l/besser-agentic-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-agentic-framework)
[![GitHub Repo stars](https://img.shields.io/github/stars/besser-pearl/besser-agentic-framework?style=social)](https://star-history.com/#besser-pearl/besser-agentic-framework)

The BESSER Agentic Framework (BAF) 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 agents, bots and chatbots easier and accessible for everyone.

**Check out the official [documentation](https://besser-agentic-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-agentic-framework/):

```bash
pip install besser-agentic-framework
```

This command will install the base package with the core dependencies, but will omit some optional dependencies.

You can add the following tags to the installation:

- ``extras``: It will install the necessary dependencies for some additional agent functionalities (e.g., RAG, Speech-to-Text, plotly, opencv).
- ``llms``: Necessary dependencies to run LLMs (openai, replicate, transformers)
- ``tensorflow``: Necessary for the SimpleIntentClassifier. Since tensorflow is a very heavy package, this allows to install it only if necessary
- ``torch``: To install PyTorch (necessary for some HuggingFace models)
- ``docs``: Dependencies to compile the project documentation (the one you are reading now)
- ``all``: **It installs all the dependencies at once**

This is how you would install the package with additional dependencies:

```bash
  pip install besser-agentic-framework[extras,llms,tensorflow]
```

If you cloned this repository, you can install the dependencies in 2 ways:

```bash
pip install -e .[extras]
```

or by referencing to the requirements files:

```bash
pip install -r requirements/requirements-extras.txt
```

Note that if you want to set your agent's language to **Luxembourgish**, you will need to manually install the [spellux](https://github.com/questoph/spellux) library. 

### Example agents

- [greetings_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/greetings_agent.py): Very simple agent for the first contact with the framework
- [weather_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/weather_agent.py): Introducing [entities](https://besser-agentic-framework.readthedocs.io/latest/wiki/core/entities.html)
- [llm_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/llm_agent.py): Introducing [Large Language Models (LLMs)](https://besser-agentic-framework.readthedocs.io/latest/wiki/nlp/llm.html)
- [rag_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/rag_agent.py): Introducing [Retrieval Augmented Generation (RAG)](https://besser-agentic-framework.readthedocs.io/latest/wiki/nlp/rag.html)
- [telegram_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/telegram_agent.py): Introducing the [TelegramPlatform](https://besser-agentic-framework.readthedocs.io/latest/wiki/platforms/telegram_platform.html)

For more example agents, check out the [BAF-agent-examples](https://github.com/BESSER-PEARL/BAF-agent-examples) repository!

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "besser-agentic-framework",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "agent, bot, framework, chatbot, state-machine, nlp",
    "author": "Luxembourg Institute of Science and Technology",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/8d/3f/d483147ea1bfa03f5aecde618cb97b2d3b3f15b00dee37f0684144413d40/besser_agentic_framework-2.0.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n  <img src=\"./docs/source/_static/baf_logo_readme.svg\" alt=\"BESSER Agentic 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-agentic-framework/)\n[![PyPI version](https://img.shields.io/pypi/v/besser-agentic-framework?logo=pypi&logoColor=white)](https://pypi.org/project/besser-agentic-framework/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/besser-agentic-framework)](https://pypi.org/project/besser-agentic-framework/)\n[![Documentation Status](https://readthedocs.org/projects/besser-agentic-framework/badge/?version=latest)](https://besser-agentic-framework.readthedocs.io/latest/?badge=latest)\n[![PyPI - License](https://img.shields.io/pypi/l/besser-agentic-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-agentic-framework)\n[![GitHub Repo stars](https://img.shields.io/github/stars/besser-pearl/besser-agentic-framework?style=social)](https://star-history.com/#besser-pearl/besser-agentic-framework)\n\nThe BESSER Agentic Framework (BAF) 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\nto make the design and implementation of agents, bots and chatbots easier and accessible for everyone.\n\n**Check out the official [documentation](https://besser-agentic-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-agentic-framework/):\n\n```bash\npip install besser-agentic-framework\n```\n\nThis command will install the base package with the core dependencies, but will omit some optional dependencies.\n\nYou can add the following tags to the installation:\n\n- ``extras``: It will install the necessary dependencies for some additional agent functionalities (e.g., RAG, Speech-to-Text, plotly, opencv).\n- ``llms``: Necessary dependencies to run LLMs (openai, replicate, transformers)\n- ``tensorflow``: Necessary for the SimpleIntentClassifier. Since tensorflow is a very heavy package, this allows to install it only if necessary\n- ``torch``: To install PyTorch (necessary for some HuggingFace models)\n- ``docs``: Dependencies to compile the project documentation (the one you are reading now)\n- ``all``: **It installs all the dependencies at once**\n\nThis is how you would install the package with additional dependencies:\n\n```bash\n  pip install besser-agentic-framework[extras,llms,tensorflow]\n```\n\nIf you cloned this repository, you can install the dependencies in 2 ways:\n\n```bash\npip install -e .[extras]\n```\n\nor by referencing to the requirements files:\n\n```bash\npip install -r requirements/requirements-extras.txt\n```\n\nNote that if you want to set your agent's language to **Luxembourgish**, you will need to manually install the [spellux](https://github.com/questoph/spellux) library. \n\n### Example agents\n\n- [greetings_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/greetings_agent.py): Very simple agent for the first contact with the framework\n- [weather_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/weather_agent.py): Introducing [entities](https://besser-agentic-framework.readthedocs.io/latest/wiki/core/entities.html)\n- [llm_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/llm_agent.py): Introducing [Large Language Models (LLMs)](https://besser-agentic-framework.readthedocs.io/latest/wiki/nlp/llm.html)\n- [rag_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/rag_agent.py): Introducing [Retrieval Augmented Generation (RAG)](https://besser-agentic-framework.readthedocs.io/latest/wiki/nlp/rag.html)\n- [telegram_agent](https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/blob/main/besser/agent/test/examples/telegram_agent.py): Introducing the [TelegramPlatform](https://besser-agentic-framework.readthedocs.io/latest/wiki/platforms/telegram_platform.html)\n\nFor more example agents, check out the [BAF-agent-examples](https://github.com/BESSER-PEARL/BAF-agent-examples) repository!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "BESSER Agentic Framework (BAF)",
    "version": "2.0.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/BESSER-PEARL/BESSER-Agentic-Framework/issues",
        "Documentation": "https://besser-agentic-framework.readthedocs.io/",
        "Source Code": "https://github.com/BESSER-PEARL/BESSER-Agentic-Framework"
    },
    "split_keywords": [
        "agent",
        " bot",
        " framework",
        " chatbot",
        " state-machine",
        " nlp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0c5635c90da6f29a9269f89c2ca32ca48b6623a9b5d2f227d56bdb19625e924a",
                "md5": "c8aadc6bfce12bdabbd6fdd980576b29",
                "sha256": "c3c8b13426110d627c89ea8f719b5f245b100be7439d37ae277896932e8b6844"
            },
            "downloads": -1,
            "filename": "besser_agentic_framework-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c8aadc6bfce12bdabbd6fdd980576b29",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 110090,
            "upload_time": "2025-01-14T16:32:26",
            "upload_time_iso_8601": "2025-01-14T16:32:26.852530Z",
            "url": "https://files.pythonhosted.org/packages/0c/56/35c90da6f29a9269f89c2ca32ca48b6623a9b5d2f227d56bdb19625e924a/besser_agentic_framework-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8d3fd483147ea1bfa03f5aecde618cb97b2d3b3f15b00dee37f0684144413d40",
                "md5": "c950668f74d282c13f99fbcae9a4d635",
                "sha256": "f60399ed87ae2eff8f084cd97d5c02f31efb6bd2d3eb177c91eee721e68c704c"
            },
            "downloads": -1,
            "filename": "besser_agentic_framework-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c950668f74d282c13f99fbcae9a4d635",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 76930,
            "upload_time": "2025-01-14T16:32:28",
            "upload_time_iso_8601": "2025-01-14T16:32:28.328794Z",
            "url": "https://files.pythonhosted.org/packages/8d/3f/d483147ea1bfa03f5aecde618cb97b2d3b3f15b00dee37f0684144413d40/besser_agentic_framework-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-14 16:32:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BESSER-PEARL",
    "github_project": "BESSER-Agentic-Framework",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "besser-agentic-framework"
}
Luxembourg Institute of Science and Technology
Elapsed time: 0.47756s