Metadata-Version: 1.1
Name: edx-toggles
Version: 1.1.1
Summary: Library and utilities for feature toggles
Home-page: https://github.com/edx/edx-toggles
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Description: edx-toggles
        =============================
        
        |pypi-badge| |travis-badge| |codecov-badge| |doc-badge| |pyversions-badge|
        |license-badge|
        
        Library and utilities for feature toggles. This repo is intended to house a utility
        for enhanced feature toggle management in Django apps used throughout the edX
        ecosystem. Currenty, it only contains some scripts for reporting on the status of
        feature toggles. See this `README`_ for more information.
        
        .. _README: 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 <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 Open edX code in general.
        
        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 <https://github.com/edx/edx-toggles/blob/master/.github/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 <https://github.com/edx/edx-toggles/blob/master/.github/ISSUE_TEMPLATE.md>`_
        
        Reporting Security Issues
        -------------------------
        
        Please do not report security issues in public. Please email security@edx.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
        
        .. |travis-badge| image:: https://travis-ci.org/edx/edx-toggles.svg?branch=master
            :target: https://travis-ci.org/edx/edx-toggles
            :alt: Travis
        
        .. |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/edx/edx-toggles/blob/master/LICENSE.txt
            :alt: License
        
        
        Change Log
        ----------
        
        ..
           All enhancements and patches to edx_toggles 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.
        
        [1.1.1] - 2020-10-27
        ~~~~~~~~~~~~~~~~~~~~
        
        * Fix cache-checking in WaffleSwitchNamespace
        
        [1.1.0] - 2020-10-23
        ~~~~~~~~~~~~~~~~~~~~
        
        * Backport ``override_waffle_switch`` test utility function from edx-platform
        
        [1.0.0] - 2020-10-13
        ~~~~~~~~~~~~~~~~~~~~
        
        * Fix missing ``module_name`` argument in ``SettingDictToggle`` constructor.
        * Extract waffle classes from edx-platform and move them here following ADR `#2 <docs/decisions/0002-application-toggle-state.rst>`__, `#3 <docs/decisions/0003-django-setting-toggles.rst>`__, `#4 <docs/decisions/0004-toggle-api.rst>`__. This does not introduce backward-incompatible changes, *yet*.
        * Fix pinned requirements and incorrect root url that overrode edx-platform's.
        
        [0.3.0] - 2020-09-23
        ~~~~~~~~~~~~~~~~~~~~
        
        First release to PyPI (2020-10-02)
        
        * Implement ``SettingToggle`` and ``SettingDictToggle``.
        
        [0.2.2] - 2020-09-11
        ~~~~~~~~~~~~~~~~~~~~
        
        * Document the writing of feature toggles annotations.
        
        [0.2.1] - 2020-08-03
        ~~~~~~~~~~~~~~~~~~~~
        
        * Add ADR for the purpose of this repository.
        * Add ADR for implementing a Toggle State endpoint.
        * Add toggles report with CSV output using new CsvRenderer.
        * Add CourseWaffleFlag and course override data to toggle report.
        * Add output for waffle flag course overrides to data gatherer
        * Add additional options to scripts/feature_toggle_report_generator
        
            * filter toggle types and envs, add github_url, and change name of ida in report
        
        * Modified scripts/feature_toggle_report_generator to work based on envs
        * Removed confluence integration
        * Moved HtmlRenderer to its own file
        * Add ADR for new SettingToggle. (see 0003-django-setting-toggles.rst)
        
        [0.2.0] - 2020-05-27
        ~~~~~~~~~~~~~~~~~~~~
        
        * Removed caniusepython3.
        
        [0.2.0] - 2020-05-05
        ~~~~~~~~~~~~~~~~~~~~
        
        * Added support for python 3.8 and dropped support Django versions older than 2.2
        
        [0.1.0] - 2019-04-08
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        * Initial version
        
Keywords: Django edx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
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.5
Classifier: Programming Language :: Python :: 3.8
