Metadata-Version: 2.4
Name: panorama-openedx-backend
Version: 21.0.0
Summary: Django app that implements backend functions for Panorama MFE
Home-page: https://github.com/aulasneo/panorama-openedx-backend
Author: Aulasneo
Author-email: andres@aulasneo.com
License: LicenseRef-Proprietary
Keywords: Panorama openedx backend MFE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: Django<5.3,>=5.2
Requires-Dist: boto3==1.40.62
Requires-Dist: django-model-utils
Requires-Dist: djangorestframework
Requires-Dist: openedx-atlas
Requires-Dist: requests>=2.33.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# panorama-openedx-backend

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

[![PyPI](https://img.shields.io/pypi/v/panorama-openedx-backend.svg)](https://pypi.python.org/pypi/panorama-openedx-backend/)
[![CI](https://github.com/aulasneo/panorama-openedx-backend/workflows/Python%20CI/badge.svg?branch=main)](https://github.com/aulasneo/panorama-openedx-backend/actions)
[![Documentation](https://readthedocs.org/projects/panorama-openedx-backend/badge/?version=latest)](https://docs.openedx.org/projects/panorama-openedx-backend)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/panorama-openedx-backend.svg)](https://pypi.python.org/pypi/panorama-openedx-backend/)
[![License](https://img.shields.io/github/license/aulasneo/panorama-openedx-backend.svg)](https://github.com/aulasneo/panorama-openedx-backend/blob/main/LICENSE.txt)
![status-badge](https://img.shields.io/badge/Status-Maintained-brightgreen)

## Purpose

Django app that implements backend functions for Panorama MFE.

[Panorama](https://aulasneo.com/open-edx-analytics/) is the 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, 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:

```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` 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>.
