EdX utilities for Django Application development.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
.tx
docs
edx_django_utils
requirements
test_utils
tests
.coveragerc
.gitignore
.travis.yml
AUTHORS
CHANGELOG.rst
LICENSE.txt
MANIFEST.in
Makefile
README.rst
codecov.yml
manage.py
openedx.yaml
pylintrc
pylintrc_tweaks
setup.cfg
setup.py
test_settings.py
tox.ini

README.rst

edx-django-utils

PyPI Travis Codecov Documentation Supported Python versions License

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.

Overview

This repository includes shared utilities for:

  • Cache Utilities: Includes a RequestCache and a TieredCache.
  • Monitoring Utilities: Includes Middleware and utilities for enhancing metrics output. At this time, supports NewRelic monitoring.

Documentation

The full documentation is in the docs directory.

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

License

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

Please see LICENSE.txt for details.

How To Contribute

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

Reporting Security Issues

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

Getting Help

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