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 with Development
********************************
Please see the Open edX documentation for `guidance on Python development <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>`_ in this repo.
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://docs.openedx.org/projects/openedx-filters/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 `Open edX Getting Help`_ page.
.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _Open edX 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@openedx.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
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/openedx-filters",
"name": "openedx-filters",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Python openedx",
"author": "eduNEXT",
"author_email": "technical@edunext.co",
"download_url": "https://files.pythonhosted.org/packages/b3/ef/a5a56653f1bd5b39e3bb6cd1214973a94dfe61ae4ac66bf401f591a2fc3b/openedx-filters-1.8.0.tar.gz",
"platform": null,
"description": "Open edX Filters\n################\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nOpen edX Filters from Hooks Extensions Framework (`OEP-50`_).\n\n.. _OEP-50: https://open-edx-proposals.readthedocs.io/en/latest/oep-0050-hooks-extension-framework.html\n\nPurpose\n*******\n\nThis repository implements the necessary tooling and\ndefinitions used by the Hooks Extension Framework to\nmanage the filters execution and extra tools.\n\n\nGetting Started with Development\n********************************\n\nPlease see the Open edX documentation for `guidance on Python development <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>`_ in this repo.\n\nDeploying\n*********\n\nThe Open edX Filters component is a Python library which doesn't\nneed independent deployment. Therefore, its setup is reasonably\nstraightforward. First, it needs to be added to your service\nrequirements, and then it will be installed alongside requirements\nof the service.\n\nIf the service you intend to use is either the LMS or CMS, then\nthe library is installed alongside their requirements since the\nNutmeg release.\n\nGetting Help\n************\n\nDocumentation\n=============\n\nSee `documentation on Read the Docs <https://docs.openedx.org/projects/openedx-filters/en/latest/>`_.\n\nMore Help\n=========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the\ncommunity.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.\n\nFor anything non-trivial, the best path is to open an issue in this\nrepository with as many details about the issue you are facing as you\ncan provide.\n\nhttps://github.com/openedx/openedx-filters/issues\n\nFor more information about these options, see the `Open edX Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _Open edX Getting Help: https://openedx.org/getting-help\n\nLicense\n*******\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nContributing\n************\n\nContributions are very welcome.\nPlease read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features. However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nThe Open edX Code of Conduct\n****************************\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n******\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://backstage.openedx.org/catalog/default/component/openedx-filters\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-filters.svg\n :target: https://pypi.python.org/pypi/openedx-filters/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/openedx/openedx-filters/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/openedx/openedx-filters/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/openedx-filters/coverage.svg?branch=main\n :target: https://codecov.io/github/openedx/openedx-filters?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/openedx-filters/badge/?version=latest\n :target: https://openedx-filters.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-filters.svg\n :target: https://pypi.python.org/pypi/openedx-filters/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/openedx-filters.svg\n :target: https://github.com/openedx/openedx-filters/blob/main/LICENSE.txt\n :alt: License\n\n.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Open edX Filters from Hooks Extensions Framework (OEP-50).",
"version": "1.8.0",
"project_urls": {
"Homepage": "https://github.com/openedx/openedx-filters"
},
"split_keywords": [
"python",
"openedx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9437d2c0e2a33d27c395c71488fc26fc2e0bf936a267445919814b46b57de5fb",
"md5": "3e86c63c95c99f43f18ee7a19ec45e10",
"sha256": "d220191a3f5f2e3135ae0cefab162e57d05bcb6a1268211849a77267d4bb93e8"
},
"downloads": -1,
"filename": "openedx_filters-1.8.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e86c63c95c99f43f18ee7a19ec45e10",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 31229,
"upload_time": "2024-04-11T22:45:12",
"upload_time_iso_8601": "2024-04-11T22:45:12.106999Z",
"url": "https://files.pythonhosted.org/packages/94/37/d2c0e2a33d27c395c71488fc26fc2e0bf936a267445919814b46b57de5fb/openedx_filters-1.8.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3efa5a56653f1bd5b39e3bb6cd1214973a94dfe61ae4ac66bf401f591a2fc3b",
"md5": "dd19fef6fdb48d7b45d11536ecbf9269",
"sha256": "d1536a0bdc1bdd9fb6ca19fdfa4a27a3474775c1e0515af8bde3267cb2bd8428"
},
"downloads": -1,
"filename": "openedx-filters-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "dd19fef6fdb48d7b45d11536ecbf9269",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33155,
"upload_time": "2024-04-11T22:45:13",
"upload_time_iso_8601": "2024-04-11T22:45:13.953877Z",
"url": "https://files.pythonhosted.org/packages/b3/ef/a5a56653f1bd5b39e3bb6cd1214973a94dfe61ae4ac66bf401f591a2fc3b/openedx-filters-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 22:45:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "openedx-filters",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "openedx-filters"
}
JSON
