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.
- Django User and Group Utilities: Includes user and group utilities.
- IP Address Utilities: Utilities for handling request IP addresses.
- Logging Utilities: Includes log filters and an encrypted logging helper.
- Monitoring Utilities: Includes Middleware and utilities for enhanced monitoring. At this time, supports NewRelic monitoring.
- Plugin Infrastructure: Enables enhanced Django Plugin capabilities.
- Security Utilities: Includes a middleware to add CSP response headers.
- Data Generation: Management command for generating Django data based on model factories.
The full documentation is in the docs directory, and is published to https://edx-django-utils.readthedocs.org.
Please see the Open edX documentation for guidance on Python development in this repo.
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.
If you're having trouble, we have discussion forums at discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.
For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.
For more information about these options, see the Getting Help page.
Contributions are very welcome.
Please read How To Contribute for details.
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
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.
All community members are expected to follow the Open edX Code of Conduct.
The assigned maintainers for this component and other project details may be
found in Backstage. Backstage pulls this data from the catalog-info.yaml
file in this repo.
Please do not report security issues in public. Please email [email protected].
The code in this repository is licensed under the Apache License, Version 2.0, unless otherwise noted.
Please see LICENSE.txt for details.