https://github.com/openedx/edx-toggles

Library and utilities for feature toggles
https://github.com/openedx/edx-toggles

Last synced: about 1 year ago
JSON representation

Library and utilities for feature toggles

• Host: GitHub
• URL: https://github.com/openedx/edx-toggles
• Owner: openedx
• License: agpl-3.0
• Created: 2018-07-05T18:19:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-04-04T08:55:52.000Z (about 1 year ago)
• Last Synced: 2025-04-10T00:18:31.670Z (about 1 year ago)
• Language: Python
• Homepage: https://edx-toggles.readthedocs.io/en/latest/
• Size: 726 KB
• Stars: 6
• Watchers: 66
• Forks: 9
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
edx-toggles

=============================

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

|license-badge|

Library and utilities for implementing and reporting on feature toggles.

Documentation is on `Read the Docs`_.  Code repository is on `GitHub`_.

.. _Read the Docs: https://docs.openedx.org/projects/edx-toggles/en/latest/readme.html

.. _GitHub: https://github.com/openedx/edx-toggles

See the `scripts README`_ for more information on the scripts for reporting on the status of

feature toggles.

.. _scripts README: https://github.com/openedx/edx-toggles/blob/master/scripts/README.rst

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.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you

can find it it at `PULL_REQUEST_TEMPLATE.md `_

Issue report template should be automatically applied if you are sending it from github UI 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@openedx.org.

Getting Help

------------

Have a question about this repository, or about Open edX in general?  Please

refer to this `list of resources`_ if you need any assistance.

.. _list of resources: https://open.edx.org/getting-help

.. |pypi-badge| image:: https://img.shields.io/pypi/v/edx-toggles.svg

    :target: https://pypi.python.org/pypi/edx-toggles/

    :alt: PyPI

.. |ci-badge| image:: https://github.com/openedx/edx-toggles/workflows/Python%20CI/badge.svg?branch=master

    :target: https://github.com/openedx/edx-toggles/actions?query=workflow%3A%22Python+CI%22

    :alt: Github CI

.. |codecov-badge| image:: http://codecov.io/github/edx/edx-toggles/coverage.svg?branch=master

    :target: http://codecov.io/github/edx/edx-toggles?branch=master

    :alt: Codecov

.. |doc-badge| image:: https://readthedocs.org/projects/edx-toggles/badge/?version=latest

    :target: http://edx-toggles.readthedocs.io/en/latest/

    :alt: Documentation

.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/edx-toggles.svg

    :target: https://pypi.python.org/pypi/edx-toggles/

    :alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/edx/edx-toggles.svg

    :target: https://github.com/openedx/edx-toggles/blob/master/LICENSE.txt

    :alt: License