Metadata-Version: 2.4
Name: tutor-contrib-platform-notifications
Version: 21.0.1
Summary: A Tutor plugin to manage configuration and plugin slots for the Notifications tray feature.
Author: Ty Hob
Author-email: OpenCraft <help@opencraft.com>
Maintainer-email: OpenCraft <help@opencraft.com>
License: AGPL-3.0-only
Project-URL: Documentation, https://github.com/openedx/tutor-contrib-platform-notifications#readme
Project-URL: Issues, https://github.com/openedx/tutor-contrib-platform-notifications/issues
Project-URL: Source, https://github.com/openedx/tutor-contrib-platform-notifications
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: tutor<22.0.0,>=21
Requires-Dist: tutor-mfe<22.0.0,>=21
Provides-Extra: dev
Requires-Dist: tutor[dev]<22.0.0,>=21.0.0; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

Notifications plugin for `Tutor <https://docs.tutor.edly.io>`__
###############################################################

A Tutor plugin to manage plugin slot and configuration for tray and email notifications feature. Learn
more about it in
`Notifications & Preferences <https://docs.openedx.org/en/latest/learners/sfd_notifications/index.html>`_ 


Installation
************

.. code-block:: bash

    pip install git+https://github.com/openedx/tutor-contrib-notifications

Usage
*****

.. code-block:: bash

    tutor plugins enable notifications


Configuration
*************

The plugin exposes the following Tutor configuration keys:
  - ``NOTIFICATIONS_DEFAULT_FROM_EMAIL``
  - Default: inherits from the platform `CONTACT_EMAIL`.
  - Purpose: sets the default "from" address used when sending notification emails.

.. code-block:: yaml

    NOTIFICATIONS_DEFAULT_FROM_EMAIL: "no-reply@example.org"

After changing configuration,restart environment so the new environment variable and settings are picked up by the LMS and MFE images.
If you rely on a specific "from" email for outgoing notifications, explicitly set ``NOTIFICATIONS_DEFAULT_FROM_EMAIL`` rather than relying on the platform-wide ``CONTACT_EMAIL``.

Visibility of email notification preferences in the Notifications section on the Account Settings
page is governed by the `NOTIFICATIONS_ENABLE_SHOW_EMAIL_CHANNEL` setting. It is TRUE by default.

Visibility of mobile push notification preferences in the Notifications section on the Account Settings
page is governed by the `NOTIFICATIONS_ENABLE_SHOW_PUSH_CHANNEL`. It is FALSE by default because we do
NOT have support for mobile push notifications at the moment.


License
*******

This software is licensed under the terms of the AGPLv3.
