Metadata-Version: 2.4
Name: ol-openedx-chat-xblock
Version: 0.3.0
Summary: An Open edX xBlock to add Open Learning AI chat
Project-URL: Homepage, https://github.com/mitodl/edx-extensions
Author-email: MIT Office of Digital Learning <odl@mit.edu>
License: BSD-3-Clause
License-File: LICENSE
Keywords: Python,edx
Requires-Python: >=3.11
Requires-Dist: django>=3.2
Requires-Dist: djangorestframework>=3.14.0
Requires-Dist: edx-django-utils>=1.3.0
Requires-Dist: xblock-utils>=1.2.0
Requires-Dist: xblock>=1.9.0
Description-Content-Type: text/x-rst




OL OpenedX Chat xBlock
######################

An xBlock to add MIT Open Learning chat in courses.


Purpose
*******

MIT's AI chatbot xBlock for Open edX

Setup
=====

For detailed installation instructions, please refer to the `plugin installation guide <../../docs#installation-guide>`_.

Installation required in:

* LMS
* Studio (CMS)

Configuration
=============

1. edx-platform configuration
-----------------------------
- Go to the course page in Studio (CMS), open ``Advanced Settings`` and add ``ol_openedx_chat_xblock`` to the ``Advanced module list``.
- To add this xBlock to a course, you can now select the ``Advanced`` tile on the new unit page and select ``OL Chat xBlock`` from the list of available advanced xBlocks.
- Add the following configuration values to the config file in Open edX. For any release after Juniper, that config file is ``/edx/etc/lms.yml``. If you're using ``private.py``, add these values to ``lms/envs/private.py``. These should be added to the top level. **Ask a fellow developer for these values.**

  .. code-block::

    MIT_LEARN_AI_XBLOCK_CHAT_API_URL: <MIT_LEARN_AI_XBLOCK_CHAT_API_URL>
    MIT_LEARN_AI_XBLOCK_CHAT_API_TOKEN: <MIT_LEARN_AI_XBLOCK_CHAT_API_TOKEN>

- For Tutor installations, these values can also be managed through a `custom Tutor plugin <https://docs.tutor.edly.io/tutorials/plugin.html#plugin-development-tutorial>`_.


Documentation
=============

License
*******

The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.

Please see `LICENSE.txt <LICENSE.txt>`_ for details.
