Metadata-Version: 2.4
Name: openedx-next-tutor
Version: 20.0.0
Summary: Nex Chat widget integration for Open edX Tutor v20 deployments
License: MIT
Keywords: tutor,openedx,plugin,nex-chat,mfe
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: tutor<21,>=20
Requires-Dist: tutor-mfe<21,>=20

# openedx-next-tutor

`openedx-next-tutor` installs the Nex Chat learner widget into Open edX Tutor v20 deployments. It adds chat entry points to the legacy LMS dashboard and supported Learning and Learner Dashboard MFEs, using the learner's existing Open edX session.

Service and deployment information: [https://nex.abconlinecourses.com/](https://nex.abconlinecourses.com/)

## Compatibility

- Open edX Tutor 20.x
- Tutor MFE 20.x
- Python 3.8 or later

## Install

```bash
python -m pip install openedx-next-tutor==20.0.0
tutor plugins enable mfe
tutor plugins enable nex-chat
```

Set `NEX_CHAT_API_BASE_URL`, `NEX_CHAT_WS_URL`, and `NEX_CHAT_TENANT_ID` through Tutor configuration, then save the configuration and rebuild the affected images:

```bash
tutor config save
tutor images build openedx-dev
tutor images build mfe
tutor dev start -d lms mfe
```

For production LMS images, use `tutor images build openedx`.

## Operational model

The package includes the browser bundle and Tutor patch templates. It connects to a separately provisioned Nex Chat service. Tenants must configure their own approved API and WebSocket endpoints before deployment.

The dashboard opens tenant-global Community chat. Supported course pages open Course chat only when the canonical course key is enabled for that tenant.

## Security

Learner identity and authorization are established by server-verified Open edX assertions. Do not embed secrets, signing material, or private API credentials in Tutor configuration or browser assets.
