EdX utilities for Django Application development.

Note that some utilities may warrant their own repository. A judgement call needs to be made as to whether code properly belongs here or not. Please review with the Architecture Team if you have any questions.

This repository includes shared utilities for:

• Cache Utilities: Includes a RequestCache and a TieredCache.
• Monitoring Utilities: Includes Middleware and utilities for enhanced monitoring. At this time, supports NewRelic monitoring.
• Plugin Infrastructure: Enables enhanced Django Plugin capabilities.

The full documentation is in the docs directory.

TODO: Publish to https://edx-django-utils.readthedocs.org.

All tools in edx_django_utils should expose their public api in their __init__.py files. This entails adding to __init__.py all functions/classes/constants/objects that are intended to be used by users of library.

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

Contributions are very welcome.

Please read How To Contribute for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md

Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you can find it at ISSUE_TEMPLATE.md

Please do not report security issues in public. Please email security@edx.org.

Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.