panorama-openedx-backend 16.0.13
Django app that implements backend functions for Panorama MFE
Requires Python: >=3.8
Keywords: Panorama openedx backend MFE

panorama-openedx-backend
#############################

This is a Django app for Open edX that implements all backend functions
needed by the Panorama MFE to work.

|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|

Purpose
*******

Django app that implements backend functions for Panorama MFE

`Panorama <https://aulasneo.com/open-edx-analytics/>`_ is the ultimate
analytics system for Open edX and more.

This code is not intended to be installed by itself.
To install Panorama in your Open edX instance please install the
`Panorama Tutor plugin <https://github.com/aulasneo/tutor-contrib-panorama>`_.

Getting Started with Development
********************************

Please see the Open edX documentation for `guidance on Python development <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>`_ in this repo.

Deploying
*********

To deploy for development, add a simple Tutor plugin with:

.. code-block:: python

    from tutor import hooks as tutor_hooks

    tutor_hooks.Filters.MOUNTED_DIRECTORIES.add_item(("openedx", "panorama-openedx-backend"))

Then use `tutor mounts` to mount your local copy of the repo.

Getting Help
************

Contact
=============

Contact us at https://aulasneo.com if you need support.


License
*******

The code in this repository is licensed under the Not open source unless
otherwise noted.

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

Contributing
************

Contributions are very welcome.

This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features.  However, please make sure
to have a discussion about your new feature idea with the maintainers prior to
beginning development to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.

Reporting Security Issues
*************************

Please do not report security issues in public. Please email info@aulasneo.com.

.. |pypi-badge| image:: https://img.shields.io/pypi/v/panorama-openedx-backend.svg
    :target: https://pypi.python.org/pypi/panorama-openedx-backend/
    :alt: PyPI

.. |ci-badge| image:: https://github.com/aulasneo/panorama-openedx-backend/workflows/Python%20CI/badge.svg?branch=main
    :target: https://github.com/aulasneo/panorama-openedx-backend/actions
    :alt: CI

.. |codecov-badge| image:: https://codecov.io/github/aulasneo/panorama-openedx-backend/coverage.svg?branch=main
    :target: https://codecov.io/github/aulasneo/panorama-openedx-backend?branch=main
    :alt: Codecov

.. |doc-badge| image:: https://readthedocs.org/projects/panorama-openedx-backend/badge/?version=latest
    :target: https://docs.openedx.org/projects/panorama-openedx-backend
    :alt: Documentation

.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/panorama-openedx-backend.svg
    :target: https://pypi.python.org/pypi/panorama-openedx-backend/
    :alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/aulasneo/panorama-openedx-backend.svg
    :target: https://github.com/aulasneo/panorama-openedx-backend/blob/main/LICENSE.txt
    :alt: License

.. .. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red


Change Log
##########

..
   All enhancements and patches to panorama_openedx_backend 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/).

Version 16.0.13 (2025-12-02)
****************************

Fix dashboard views for author users

Version 16.0.12 (2024-08-09)
****************************

* fix: Support STUDENT role

Version 16.0.11 (2024-08-09)
****************************

* fix: return student dashboards if the user is not listed in the access
  configuration and the student view is enabled.

Version 16.0.10 (2024-08-05)
****************************

* fix: Fix bug when retrieving the default user arn from the settings.
* fix: Fix allowed domain when generating embed url

Version 16.0.9 (2024-06-11)
***************************

* Manage nonexistent user access configuration

Version 16.0.8 (2024-06-11)
***************************

* Show "available to students" field in the "dashboard type"'s admin list.

Version 16.0.7 (2024-06-10)
***************************

* Increase timeout to 60 secs in api calls

Version 16.0.6 (2024-06-10)
***************************

* Add user role (dashboard_function) to the signed requests to the api.
  This allows for Author, AI and Student views in SaaS modes.

Version 16.0.5 (2024-06-08)
***************************

* Fix SigV4 calls

Version 16.0.4 (2024-06-06)
***************************

* Return "STUDENT" user role in SAAS and CUSTOM modes.
* Return PANORAMA_DEFAULT_USER_ARN if there is no user access configuration.

Version 16.0.3 (2024-06-05)
***************************

* Initial release