Metadata-Version: 1.2
Name: edx-notices
Version: 0.9.0
Summary: An edx-platform plugin which manages notices that must be acknowledged
Home-page: https://github.com/edx/platform-plugin-notices
Author: edX
Author-email: mtuchfarber@edx.org
License: AGPL 3.0
Description: platform-plugin-notices
        =============================
        
        |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge| |license-badge|
        
        **This repo is not currently accepting open source contributions**
        
        Overview
        --------
        
        This plugin for edx-platform manages notices that a user must acknowledge. It only stores the content of the notices and whether a user has acknowledged them. Presentation and other client side decisions will be left to the frontends that utilize these APIs.
        
        This Django app contains notices that a user must acknowledge before continuing to use the site. This app will have two API endpoints to facilitate that:
        1. An endpoint to return links to all notices that the user hasn't acknowledged.
        2. An endpoint to acknowledge that a user has seen the notice. This endpoint's URL will be passed to the client via the first endpoint.
        
        Documentation
        -------------
        
        (TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
        
        Developing in Devstack
        ~~~~~~~~~~~~~~~~~~~~~~
        Make sure the LMS container is running in Devstack, then
        
        .. code-block::
        
          git clone git@github.com:edx/platform-plugin-notices.git <devstack_folder>/src
          cd <devstack_folder>/devstack
          make dev.shell.lms
          pip install -e /edx/src/platform-plugin-notices
          cd /edx/app/edxapp/edx-platform
          ./manage.py lms migrate
        
        Once that is done, LMS will pickup the plugin and saves to existing files should cause a devserver restart with your changes. Occasionally when adding a new file, you may need to restart the LMS container in order for it to pickup the changes.
        
        License
        -------
        
        The code in this repository is licensed under the AGPL 3.0 unless
        otherwise noted.
        
        Please see `LICENSE.txt <LICENSE.txt>`_ for details.
        
        How To Contribute
        -----------------
        
        This repo is not currently accepting open source contributions
        
        Reporting Security Issues
        -------------------------
        
        Please do not report security issues in public. Please email security@edx.org.
        
        Getting Help
        ------------
        
        If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
        
        Our real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.
        
        For more information about these options, see the `Getting Help`_ page.
        
        .. _Slack invitation: https://openedx-slack-invite.herokuapp.com/
        .. _community Slack workspace: https://openedx.slack.com/
        .. _Getting Help: https://openedx.org/getting-help
        
        .. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-notices.svg
            :target: https://pypi.python.org/pypi/edx-notices/
            :alt: PyPI
        
        .. |ci-badge| image:: https://github.com/edx/platform-plugin-notices/workflows/Python%20CI/badge.svg?branch=main
            :target: https://github.com/edx/platform-plugin-notices/actions
            :alt: CI
        
        .. |codecov-badge| image:: https://codecov.io/github/edx/platform-plugin-notices/coverage.svg?branch=main
            :target: https://codecov.io/github/edx/platform-plugin-notices?branch=main
            :alt: Codecov
        
        .. |doc-badge| image:: https://readthedocs.org/projects/platform-plugin-notices/badge/?version=latest
            :target: https://platform-plugin-notices.readthedocs.io/en/latest/
            :alt: Documentation
        
        .. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-notices.svg
            :target: https://pypi.python.org/pypi/platform-plugin-notices/
            :alt: Supported Python versions
        
        .. |license-badge| image:: https://img.shields.io/github/license/edx/platform-plugin-notices.svg
            :target: https://github.com/edx/platform-plugin-notices/blob/main/LICENSE.txt
            :alt: License
        
        
        Change Log
        ----------
        
        ..
           All enhancements and patches to notices will be documented
           in this file.  It adheres to the structure of https://keepachangelog.com/ ,
           but in reStructuredText instead of Markdown (for ease of incorporation into
           Sphinx documentation and the PyPI description).
        
           This project adheres to Semantic Versioning (https://semver.org/).
        
        .. There should always be an "Unreleased" section for changes pending release.
        
        Unreleased
        ~~~~~~~~~~
        
        [0.9.0] - 2021-10-25
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Add in a snooze limit feature that will only allow a notice to be snoozed a number of times
        
        [0.8.2] - 2021-10-21
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Update requirements
        
        [0.8.1] - 2021-10-21
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Add ability to reshow notice after a snooze period via setting
        
        [0.7.3] - 2021-10-20
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Make AcknowledgedNotice user editable in the admin for testing purposes
        
        [0.7.2] - 2021-10-19
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Make AcknowledgedNotice user readonly in the admin for performance
        
        [0.7.1] - 2021-10-19
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Add Waffle Flag to enable and disable the feature for rollout
        
        [0.6.1] - 2021-10-7
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Add Python API for retrieving unack'd and active notice data
        * Add Plugin Context API for notice data to support redirects on the LMS Course Dashboard
        
        [0.5.1] - 2021-10-7
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Disallow dismissal after confirmation of notice
        
        [0.4.1] - 2021-10-7
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Allow inactive (non-email-verified) users to call APIs
        
        [0.3.1] - 2021-10-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Add mobile calls so notice code can deep link
        
        [0.2.2] - 2021-09-24
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        * Add fallback language on render view
        * Add Bearer auth to APIs for mobile
        * Add login requirement to render view
        * Add first edx-platform dependency
        
        [0.2.1] - 2021-09-22
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Added
        _____
        
        * Utility functions for custom notice code to use to call APIs
        
        [0.1.1] - 2021-09-16
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Added
        _____
        
        * Moved to server rendered notice model
        * Add mandatory types to acknowledgement to track more states
        
        [0.1.0] - 2021-08-19
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Added
        _____
        
        * First release on PyPI.
        
Keywords: Python edx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
