Metadata-Version: 2.1
Name: openedx-filters
Version: 1.1.0
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
Keywords: Python openedx
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
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

Open edX Filters
################

|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|

Open edX Filters from Hooks Extensions Framework (`OEP-50`_).

.. _OEP-50: https://open-edx-proposals.readthedocs.io/en/latest/oep-0050-hooks-extension-framework.html

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
--------------
.. code-block::

  # 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-filters

Every time you develop something in this repo
---------------------------------------------
.. code-block::

  # 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
=============

See `documentation on Read the Docs <https://openedx-filters.readthedocs.io/en/latest/>`_.

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.

.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help

License
*******

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

Please see `LICENSE.txt <LICENSE.txt>`_ for details.

Contributing
************

Contributions are very welcome.
Please read `How To Contribute <https://openedx.org/r/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`_.

.. _Open edX Code of Conduct: https://openedx.org/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.

.. _Backstage: https://backstage.openedx.org/catalog/default/component/openedx-filters

Reporting Security Issues
*************************

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

.. |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

.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen


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
----------
[1.1.0] - 2023-02-16
--------------------

Added
~~~~~

* VerticalBlockRenderCompleted filter added which can be used to modify the rendered output of a VerticalBlock.

Changed
~~~~~~~

* Introduced PreventChildBlockRender exception to the VerticalBlockChildRenderStarted filter.

[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.
