Open edX Filters from Hooks Extensions Framework (OEP-50).
Project description
Open edX Filters from Hooks Extensions Framework (OEP-50).
Purpose
This repository implements the necessary tooling and definitions used by the Hooks Extension Framework to manage the filters execution and extra tools.
Getting Started
Developing
One Time Setup
# Clone the repository
git clone git@github.com:openedx/openedx-filters.git
cd openedx-filters
# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.8 openedx-filtersEvery time you develop something in this repo
# Activate the virtualenv
workon openedx-filters
# Grab the latest code
git checkout main
git pull
# Install/update the dev requirements
make requirements
# Run the tests and quality checks (to verify the status before you make any changes)
make validate
# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>
# Using your favorite editor, edit the code to make your change.
vim …
# Run your new tests
pytest ./path/to/new/tests
# Run all the tests and quality checks
make validate
# Commit all your changes
git commit …
git push
# Open a PR and ask for review.Deploying
The Open edX Filters component is a Python library which doesn’t need independent deployment. Therefore, its setup is reasonably straightforward. First, it needs to be added to your service requirements, and then it will be installed alongside requirements of the service.
If the service you intend to use is either the LMS or CMS, then the library is installed alongside their requirements since the Nutmeg release.
Getting Help
Documentation
More Help
If you’re having trouble, we have discussion forums at https://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.
https://github.com/openedx/openedx-filters/issues
For more information about these options, see the Getting Help page.
License
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
Contributing
Contributions are very welcome. Please read How To Contribute for details.
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.
The Open edX Code of Conduct
All community members are expected to follow the Open edX Code of Conduct.
People
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.
Reporting Security Issues
Please do not report security issues in public. Please email security@tcril.org.
Change Log
Unreleased
[1.0.0] - 2023-01-18
Added
Bump version to 1.x to acknowledge that this is in use in production.
CourseEnrollmentQuerysetRequested filter added that is called when returning course enrollments queryset object.
[0.8.0] - 2022-08-18
Added
VerticalBlockChildRenderStarted filter added that is called when every child block of a VericalBlock is about to be rendered.
[0.7.0] - 2022-05-26
Added
Cohort assignment filter to be used with every cohort assignment.
[0.6.2] - 2022-04-07
Changed
Change dashboard/course about render exceptions naming for clarity
[0.6.1] - 2022-04-07
Changed
Remove CourseHomeRenderStarted since it’s not going to be used.
Change RenderAlternativeCertificate to RenderAlternativeInvalidCertificate.
[0.6.0] - 2022-04-01
Added
More significant exceptions for template interaction.
[0.5.1] - 2022-03-29
Added
More significant arguments to the certificate creation filter.
[0.5.0] - 2022-02-23
Added
Unenrollment filter definition.
Certificate creation/rendering filters.
Dashboard render filter definition.
Course home/about render filters.
Cohort change filter.
[0.4.3] - 2022-01-24
Changed
Add fail_silently when importing filter steps.
[0.4.2] - 2021-12-16
Changed
Fix dictionary mishandling in OpenEdxPublicFilter tooling.
[0.4.1] - 2021-12-16
Changed
Use run_filter instead of run in OpenEdxPublicFilter tooling.
[0.4.0] - 2021-12-15
Added
Filter definitions for registration and login.
Sensitive data mixin for filters.
Changed
Pipeline runner from run to run_filter.
Moved filters definitions to filters file inside their domain.
[0.3.0] - 2021-11-24
Added
ADRs for naming, payload and debugging tools.
OpenEdxPublicFilter class with the necessary tooling for filters execution
PreEnrollmentFilter class definition
Changed
Update doc-max-length following community recommendations.
[0.2.0] - 2021-09-02
Added
First version of Open edX Filters tooling.
Changed
Update setup.cfg with complete bumpversion configuration.
[0.1.0] - 2021-04-07
Added
First release on PyPI.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openedx_filters-1.0.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b222f0ca877f3c4e938c65a8affdd52397f10611083d2a68db8f6baba7ca0ada |
|
| MD5 | 206d89445b99565bb525dc482f3f48cd |
|
| BLAKE2b-256 | 5ae1822ab0767e4436197b2a2971c9e8a689bc92a922cae363739307d0b7e560 |
