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.1.0 (2024-08-05)
***************************
* fix: Fix bug when retrieving the default user arn from the settings.
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
Raw data
{
"_id": null,
"home_page": "https://github.com/aulasneo/panorama-openedx-backend",
"name": "panorama-openedx-backend",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Panorama openedx backend MFE",
"author": "Aulasneo",
"author_email": "andres@aulasneo.com",
"download_url": "https://files.pythonhosted.org/packages/56/73/d423f2a18b886ae0590f92ae070a8e108800e0dfb105a082c3a9d6017c06/panorama_openedx_backend-16.1.0.tar.gz",
"platform": null,
"description": "panorama-openedx-backend\n#############################\n\nThis is a Django app for Open edX that implements all backend functions\nneeded by the Panorama MFE to work.\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nPurpose\n*******\n\nDjango app that implements backend functions for Panorama MFE\n\n`Panorama <https://aulasneo.com/open-edx-analytics/>`_ is the ultimate\nanalytics system for Open edX and more.\n\nThis code is not intended to be installed by itself.\nTo install Panorama in your Open edX instance please install the\n`Panorama Tutor plugin <https://github.com/aulasneo/tutor-contrib-panorama>`_.\n\nGetting Started with Development\n********************************\n\nPlease 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.\n\nDeploying\n*********\n\nTo deploy for development, add a simple Tutor plugin with:\n\n.. code-block:: python\n\n from tutor import hooks as tutor_hooks\n\n tutor_hooks.Filters.MOUNTED_DIRECTORIES.add_item((\"openedx\", \"panorama-openedx-backend\"))\n\nThen use `tutor mounts` to mount your local copy of the repo.\n\nGetting Help\n************\n\nContact\n=============\n\nContact us at https://aulasneo.com if you need support.\n\n\nLicense\n*******\n\nThe code in this repository is licensed under the Not open source unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nContributing\n************\n\nContributions are very welcome.\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features. However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email info@aulasneo.com.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/panorama-openedx-backend.svg\n :target: https://pypi.python.org/pypi/panorama-openedx-backend/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/aulasneo/panorama-openedx-backend/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/aulasneo/panorama-openedx-backend/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/aulasneo/panorama-openedx-backend/coverage.svg?branch=main\n :target: https://codecov.io/github/aulasneo/panorama-openedx-backend?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/panorama-openedx-backend/badge/?version=latest\n :target: https://docs.openedx.org/projects/panorama-openedx-backend\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/panorama-openedx-backend.svg\n :target: https://pypi.python.org/pypi/panorama-openedx-backend/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/aulasneo/panorama-openedx-backend.svg\n :target: https://github.com/aulasneo/panorama-openedx-backend/blob/main/LICENSE.txt\n :alt: License\n\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow\n.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to panorama_openedx_backend 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\nVersion 16.1.0 (2024-08-05)\n***************************\n\n* fix: Fix bug when retrieving the default user arn from the settings.\n\nVersion 16.0.9 (2024-06-11)\n***************************\n\n* Manage nonexistent user access configuration\n\nVersion 16.0.8 (2024-06-11)\n***************************\n\n* Show \"available to students\" field in the \"dashboard type\"'s admin list.\n\nVersion 16.0.7 (2024-06-10)\n***************************\n\n* Increase timeout to 60 secs in api calls\n\nVersion 16.0.6 (2024-06-10)\n***************************\n\n* Add user role (dashboard_function) to the signed requests to the api.\n This allows for Author, AI and Student views in SaaS modes.\n\nVersion 16.0.5 (2024-06-08)\n***************************\n\n* Fix SigV4 calls\n\nVersion 16.0.4 (2024-06-06)\n***************************\n\n* Return \"STUDENT\" user role in SAAS and CUSTOM modes.\n* Return PANORAMA_DEFAULT_USER_ARN if there is no user access configuration.\n\nVersion 16.0.3 (2024-06-05)\n***************************\n\n* Initial release\n",
"bugtrack_url": null,
"license": null,
"summary": "Django app that implements backend functions for Panorama MFE",
"version": "16.1.0",
"project_urls": {
"Homepage": "https://github.com/aulasneo/panorama-openedx-backend"
},
"split_keywords": [
"panorama",
"openedx",
"backend",
"mfe"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d52dad56899a3a024de84f02ffc0b36296f7edd90849f08a6c2979a6ee79c36b",
"md5": "65863883561f6c0c6b7b1e4ae73a87a0",
"sha256": "cba72c0340db7c79476c491af40de214a8ca952b6c0c1fb6c56648ee37d1cf51"
},
"downloads": -1,
"filename": "panorama_openedx_backend-16.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "65863883561f6c0c6b7b1e4ae73a87a0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 15939,
"upload_time": "2024-08-05T12:53:54",
"upload_time_iso_8601": "2024-08-05T12:53:54.076581Z",
"url": "https://files.pythonhosted.org/packages/d5/2d/ad56899a3a024de84f02ffc0b36296f7edd90849f08a6c2979a6ee79c36b/panorama_openedx_backend-16.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5673d423f2a18b886ae0590f92ae070a8e108800e0dfb105a082c3a9d6017c06",
"md5": "31ad065fc32a2aab5c3c0e95fee0b952",
"sha256": "15aa30dcaf1ac9e8df83a9e6f2ba59b19dfce5b446280a075c79bf2837562edf"
},
"downloads": -1,
"filename": "panorama_openedx_backend-16.1.0.tar.gz",
"has_sig": false,
"md5_digest": "31ad065fc32a2aab5c3c0e95fee0b952",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16081,
"upload_time": "2024-08-05T12:53:55",
"upload_time_iso_8601": "2024-08-05T12:53:55.729677Z",
"url": "https://files.pythonhosted.org/packages/56/73/d423f2a18b886ae0590f92ae070a8e108800e0dfb105a082c3a9d6017c06/panorama_openedx_backend-16.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 12:53:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aulasneo",
"github_project": "panorama-openedx-backend",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "panorama-openedx-backend"
}
JSON
