Welcome to ViUR Assistant
=========================


.. raw:: html

    <a href="https://pypi.org/project/viur-assistant/">
        <img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-assistant">
    </a>
    <a href="https://github.com/viur-framework/viur-assistant">
        <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/viur-framework/viur-assistant?style=flat&label=GitHub%20Repo%20stars">
    </a>
    <a href="LICENSE">
        <img src="https://img.shields.io/github/license/viur-framework/viur-assistant" alt="Badge displaying the license" title="License badge">
    </a>


.. TODO:
  .. image:: images/viur-assistant.svg

ViUR Assistant is a powerful Python module designed to integrate AI assistant
capabilities seamlessly into your `ViUR <https://www.viur.dev>`_ projects.
It simplifies the usage of OpenAI and Anthropic APIs with easy
configuration and modular design.

Quick Links
-----------

- `GitHub Repository <https://github.com/viur-framework/viur-assistant>`_
- `PyPi <https://pypi.org/project/viur-assistant/>`_


Dependencies
------------

- `ViUR Core <https://core.docs.viur.dev/en/stable/>`_
- `OpenAI API <https://openai.com/api/>`_
- `Anthropic API <https://www.anthropic.com>`_

-----


.. toctree::
    :maxdepth: 3
    :caption: ViUR Assistant

    getting-started
    bone-action