Open edX Filters from Hooks Extensions Framework (OEP-50).
Project description
Open edX Filters from Hooks Extensions Framework (OEP-50).
Overview
This repository implements the necessary tooling and definitions used by the Hooks Extension Framework to manage the filters execution and extra tools.
Documentation
(TODO: Set up documentation)
Development Workflow
One Time Setup
# Clone the repository
git clone git@github.com:edxuNEXT/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-filters
Every time you develop something in this repo
# Activate the virtualenv
workon openedx-filters
# Grab the latest code
git checkout master
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.
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 all Open edX projects.
The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.
The issue report template should be automatically applied if you are creating an issue on GitHub 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
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 more information about these options, see the Getting Help page.
Change Log
Unreleased
[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.
Project details
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-0.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 493dd4d678c69b669c5f127f009de885fb589e765937633ba2c045ba0e4ad642 |
|
MD5 | 53be9df0bc6f0082f8b07b9fb38b0c22 |
|
BLAKE2b-256 | 635e40a6e64c76d5d7d1edde2b4fceb80ee6003c78bce239ee16b8ef35071960 |