edx-notices


Nameedx-notices JSON
Version 0.14.55 PyPI version JSON
download
home_pagehttps://github.com/edx/platform-plugin-notices
SummaryAn edx-platform plugin which manages notices that must be acknowledged
upload_time2023-09-25 12:49:52
maintainer
docs_urlNone
authoredX
requires_python>=3.8
licenseAGPL 3.0
keywords python edx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            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.

Enabling the Notices Plugin in the LMS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Notices plugin functionality is enabled via use of a waffle flag. After installation of the plugin you need to do the following in devstack:

#. Log into the LMS Django Admin (http://localhost:18000/admin/)
#. Add a new waffle flag (http://localhost:18000/admin/waffle/flag/add/)
#. Name the waffle flag ``notices.enable_notices``
#. Set `Everyone` to `Yes`
#. Save the waffle flag.

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.

Support
-------

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.14.55] - 2023-09-25
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Fixed PyPI Publish workflow

[0.14.53] - 2023-09-22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added Django 4.2 Support

[0.14.20] - 2022-07-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Updating Python Requirements

[0.14.15] - 2022-07-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Updating Python Requirements

[0.14.11] - 2022-06-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Updating Python Requirements

[0.14.4] - 2022-02-14
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Changed Do not redirect notices/render/{id}/ to login page in case of 403 on mobile request

[0.14.3] - 2022-02-07
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Update pip-tools

[0.14.2] - 2022-01-28
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Update Python dependencies

[0.14.1] - 2022-01-05
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Update Python dependencies

[0.14.0] - 2021-11-24
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add logging

[0.13.0] - 2021-11-24
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added history table to AcknowledgedNotice

[0.12.0] - 2021-11-2
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Added support for django 3.2 and dropped support for previous versions

[0.11.8] - 2021-11-10
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Update Python dependencies

[0.11.7] - 2021-11-10
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add userLanguage flag so JavaScript-rendered text can be displayed in the correct language

[0.11.6] - 2021-11-10
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add mobile flag so mobile can be disabled in production

[0.11.5] - 2021-11-09
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add lang tag to HTML element

[0.11.4] - 2021-11-08
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Change name of segment event from "acquisition" to "notice"

[0.11.3] - 2021-11-05
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Allow user to leave page even if API call fails (important for mobile)

[0.11.2] - 2021-11-04
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Updated Django admin form list display and searchable fields.

[0.11.1] - 2021-10-29
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* fix analytics key in template

[0.11.0] - 2021-11-1
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add in a setting to limit the number of days you can snooze a notice.

[0.10.3] - 2021-10-29
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Fix dismiss button redirecting

[0.10.2] - 2021-10-29
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* fix analytics key

[0.10.1] - 2021-10-29
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Limit notices to users who were created before it was released

[0.10.0] - 2021-10-25
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Add segment library for event tracking

[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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Utility functions for custom notice code to use to call APIs

[0.1.1] - 2021-09-16
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Moved to server rendered notice model
* Add mandatory types to acknowledgement to track more states

[0.1.0] - 2021-08-19
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* First release on PyPI.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/edx/platform-plugin-notices",
    "name": "edx-notices",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "Python edx",
    "author": "edX",
    "author_email": "mtuchfarber@edx.org",
    "download_url": "https://files.pythonhosted.org/packages/f8/5e/eb7a5196f878115d59af90bc5f9870954afa24ac09a889ca8c26c10bc4ca/edx-notices-0.14.55.tar.gz",
    "platform": null,
    "description": "platform-plugin-notices\n=============================\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge| |license-badge|\n\n**This repo is not currently accepting open source contributions**\n\nOverview\n--------\n\nThis 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.\n\nThis 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:\n1. An endpoint to return links to all notices that the user hasn't acknowledged.\n2. 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.\n\nDocumentation\n-------------\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\n\nDeveloping in Devstack\n~~~~~~~~~~~~~~~~~~~~~~\nMake sure the LMS container is running in Devstack, then\n\n.. code-block::\n\n  git clone git@github.com:edx/platform-plugin-notices.git <devstack_folder>/src\n  cd <devstack_folder>/devstack\n  make dev.shell.lms\n  pip install -e /edx/src/platform-plugin-notices\n  cd /edx/app/edxapp/edx-platform\n  ./manage.py lms migrate\n\nOnce 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.\n\nEnabling the Notices Plugin in the LMS\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe Notices plugin functionality is enabled via use of a waffle flag. After installation of the plugin you need to do the following in devstack:\n\n#. Log into the LMS Django Admin (http://localhost:18000/admin/)\n#. Add a new waffle flag (http://localhost:18000/admin/waffle/flag/add/)\n#. Name the waffle flag ``notices.enable_notices``\n#. Set `Everyone` to `Yes`\n#. Save the waffle flag.\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nHow To Contribute\n-----------------\n\nThis repo is not currently accepting open source contributions\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nSupport\n-------\n\nIf you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx-slack-invite.herokuapp.com/\n.. _community Slack workspace: https://openedx.slack.com/\n.. _Getting Help: https://openedx.org/getting-help\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-notices.svg\n    :target: https://pypi.python.org/pypi/edx-notices/\n    :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/edx/platform-plugin-notices/workflows/Python%20CI/badge.svg?branch=main\n    :target: https://github.com/edx/platform-plugin-notices/actions\n    :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/edx/platform-plugin-notices/coverage.svg?branch=main\n    :target: https://codecov.io/github/edx/platform-plugin-notices?branch=main\n    :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/platform-plugin-notices/badge/?version=latest\n    :target: https://platform-plugin-notices.readthedocs.io/en/latest/\n    :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-notices.svg\n    :target: https://pypi.python.org/pypi/platform-plugin-notices/\n    :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/platform-plugin-notices.svg\n    :target: https://github.com/edx/platform-plugin-notices/blob/main/LICENSE.txt\n    :alt: License\n\n\nChange Log\n----------\n\n..\n   All enhancements and patches to notices will be documented\n   in this file.  It adheres to the structure of https://keepachangelog.com/ ,\n   but in reStructuredText instead of Markdown (for ease of incorporation into\n   Sphinx documentation and the PyPI description).\n\n   This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n[0.14.55] - 2023-09-25\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Fixed PyPI Publish workflow\n\n[0.14.53] - 2023-09-22\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added Django 4.2 Support\n\n[0.14.20] - 2022-07-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Updating Python Requirements\n\n[0.14.15] - 2022-07-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Updating Python Requirements\n\n[0.14.11] - 2022-06-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Updating Python Requirements\n\n[0.14.4] - 2022-02-14\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Changed Do not redirect notices/render/{id}/ to login page in case of 403 on mobile request\n\n[0.14.3] - 2022-02-07\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update pip-tools\n\n[0.14.2] - 2022-01-28\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update Python dependencies\n\n[0.14.1] - 2022-01-05\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update Python dependencies\n\n[0.14.0] - 2021-11-24\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add logging\n\n[0.13.0] - 2021-11-24\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added history table to AcknowledgedNotice\n\n[0.12.0] - 2021-11-2\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added support for django 3.2 and dropped support for previous versions\n\n[0.11.8] - 2021-11-10\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update Python dependencies\n\n[0.11.7] - 2021-11-10\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add userLanguage flag so JavaScript-rendered text can be displayed in the correct language\n\n[0.11.6] - 2021-11-10\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add mobile flag so mobile can be disabled in production\n\n[0.11.5] - 2021-11-09\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add lang tag to HTML element\n\n[0.11.4] - 2021-11-08\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Change name of segment event from \"acquisition\" to \"notice\"\n\n[0.11.3] - 2021-11-05\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Allow user to leave page even if API call fails (important for mobile)\n\n[0.11.2] - 2021-11-04\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Updated Django admin form list display and searchable fields.\n\n[0.11.1] - 2021-10-29\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* fix analytics key in template\n\n[0.11.0] - 2021-11-1\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add in a setting to limit the number of days you can snooze a notice.\n\n[0.10.3] - 2021-10-29\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Fix dismiss button redirecting\n\n[0.10.2] - 2021-10-29\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* fix analytics key\n\n[0.10.1] - 2021-10-29\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Limit notices to users who were created before it was released\n\n[0.10.0] - 2021-10-25\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add segment library for event tracking\n\n[0.9.0] - 2021-10-25\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add in a snooze limit feature that will only allow a notice to be snoozed a number of times\n\n[0.8.2] - 2021-10-21\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update requirements\n\n[0.8.1] - 2021-10-21\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add ability to reshow notice after a snooze period via setting\n\n[0.7.3] - 2021-10-20\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Make AcknowledgedNotice user editable in the admin for testing purposes\n\n[0.7.2] - 2021-10-19\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Make AcknowledgedNotice user readonly in the admin for performance\n\n[0.7.1] - 2021-10-19\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add Waffle Flag to enable and disable the feature for rollout\n\n[0.6.1] - 2021-10-7\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add Python API for retrieving unack'd and active notice data\n* Add Plugin Context API for notice data to support redirects on the LMS Course Dashboard\n\n[0.5.1] - 2021-10-7\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Disallow dismissal after confirmation of notice\n\n[0.4.1] - 2021-10-7\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Allow inactive (non-email-verified) users to call APIs\n\n[0.3.1] - 2021-10-1\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add mobile calls so notice code can deep link\n\n[0.2.2] - 2021-09-24\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add fallback language on render view\n* Add Bearer auth to APIs for mobile\n* Add login requirement to render view\n* Add first edx-platform dependency\n\n[0.2.1] - 2021-09-22\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Utility functions for custom notice code to use to call APIs\n\n[0.1.1] - 2021-09-16\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Moved to server rendered notice model\n* Add mandatory types to acknowledgement to track more states\n\n[0.1.0] - 2021-08-19\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* First release on PyPI.\n",
    "bugtrack_url": null,
    "license": "AGPL 3.0",
    "summary": "An edx-platform plugin which manages notices that must be acknowledged",
    "version": "0.14.55",
    "project_urls": {
        "Homepage": "https://github.com/edx/platform-plugin-notices"
    },
    "split_keywords": [
        "python",
        "edx"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b8b9c666ecb4c083dacf6d36b627da079b057acbeb6850e448d6dcdb467d4231",
                "md5": "a26ade87990780ca7cab94d811e3f8b9",
                "sha256": "43182fab8fa590f8f231eb97ccf6a62859d60813753d4d72933015c2d1500ac3"
            },
            "downloads": -1,
            "filename": "edx_notices-0.14.55-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a26ade87990780ca7cab94d811e3f8b9",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.8",
            "size": 36927,
            "upload_time": "2023-09-25T12:49:50",
            "upload_time_iso_8601": "2023-09-25T12:49:50.632836Z",
            "url": "https://files.pythonhosted.org/packages/b8/b9/c666ecb4c083dacf6d36b627da079b057acbeb6850e448d6dcdb467d4231/edx_notices-0.14.55-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f85eeb7a5196f878115d59af90bc5f9870954afa24ac09a889ca8c26c10bc4ca",
                "md5": "2a652b41d4e337a260e0e1db397e603d",
                "sha256": "3e17cff0a7c4290cda05567579964fc8afd536991353b2a4c9c0f8cbd967f7e7"
            },
            "downloads": -1,
            "filename": "edx-notices-0.14.55.tar.gz",
            "has_sig": false,
            "md5_digest": "2a652b41d4e337a260e0e1db397e603d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 34835,
            "upload_time": "2023-09-25T12:49:52",
            "upload_time_iso_8601": "2023-09-25T12:49:52.490846Z",
            "url": "https://files.pythonhosted.org/packages/f8/5e/eb7a5196f878115d59af90bc5f9870954afa24ac09a889ca8c26c10bc4ca/edx-notices-0.14.55.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 12:49:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "edx",
    "github_project": "platform-plugin-notices",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "edx-notices"
}
        
edX
Elapsed time: 0.12080s