Metadata-Version: 1.2
Name: openedx-filters
Version: 0.6.1
Summary: Open edX Filters from Hooks Extensions Framework (OEP-50).
Home-page: https://github.com/openedx/openedx-filters
Author: eduNEXT
Author-email: technical@edunext.co
License: AGPL 3.0
Description: Open edX Filters
        ================
        
        |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
        |license-badge|
        
        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 <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
        
        Development Workflow
        --------------------
        
        One Time Setup
        ~~~~~~~~~~~~~~
        .. code-block::
        
          # 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
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        .. code-block::
        
          # 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 <LICENSE.txt>`_ for details.
        
        How To Contribute
        -----------------
        
        Contributions are very welcome.
        Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ 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 <.github/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 <.github/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.
        
        .. _Slack invitation: https://openedx-slack-invite.herokuapp.com/
        .. _community Slack workspace: https://openedx.slack.com/
        .. _Getting Help: https://openedx.org/getting-help
        .. _OEP-50: https://open-edx-proposals.readthedocs.io/en/latest/oep-0050-hooks-extension-framework.html
        
        .. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-filters.svg
            :target: https://pypi.python.org/pypi/openedx-filters/
            :alt: PyPI
        
        .. |ci-badge| image:: https://github.com/openedx/openedx-filters/workflows/Python%20CI/badge.svg?branch=main
            :target: https://github.com/openedx/openedx-filters/actions
            :alt: CI
        
        .. |codecov-badge| image:: https://codecov.io/github/openedx/openedx-filters/coverage.svg?branch=main
            :target: https://codecov.io/github/openedx/openedx-filters?branch=main
            :alt: Codecov
        
        .. |doc-badge| image:: https://readthedocs.org/projects/openedx-filters/badge/?version=latest
            :target: https://openedx-filters.readthedocs.io/en/latest/
            :alt: Documentation
        
        .. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-filters.svg
            :target: https://pypi.python.org/pypi/openedx-filters/
            :alt: Supported Python versions
        
        .. |license-badge| image:: https://img.shields.io/github/license/openedx/openedx-filters.svg
            :target: https://github.com/openedx/openedx-filters/blob/main/LICENSE.txt
            :alt: License
        
        
        Change Log
        ----------
        
        ..
           All enhancements and patches to openedx_filters will be documented
           in this file.  It adheres to the structure of https://keepachangelog.com/ ,
           but in reStructuredText instead of Markdown (for ease of incorporation into
           Sphinx documentation and the PyPI description).
           
           This project adheres to Semantic Versioning (https://semver.org/).
        
        .. There should always be an "Unreleased" section for changes pending release.
        
        Unreleased
        ~~~~~~~~~~
        
        [0.6.1] - 2022-04-07
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        * 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.
        
Keywords: Python openedx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
