edx-toggles 1.2.1

Library and utilities for feature toggles

Library and utilities for implementing and reporting on feature toggles.

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

See the scripts README for more information on the scripts for reporting on the status of feature toggles.

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.

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

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 [e-mail].

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.

Change Log

[1.2.1] - 2020-12-17

• Improve monitoring of legacy Waffle class imports. We should watch for “edx_toggles.toggles.internal.waffle.legacy.WaffleSwitch” custom attributes.

[1.2.0] - 2020-11-05

• Start the deprecation process of the waffle namespace classes:

  • Introduce LegacyWaffleFlag, LegacyWaffleSwitch for use with namespaces.

  • Begin deprecation/refactoring of namespacing code, including deprecation monitoring and warnings.

  • Note: WaffleFlag and WaffleSwitch still use namespaces as well (for now).

  • Introduce the toggles.__future__ module for applications that need to be forward-compatible right away.

[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, #3, #4. 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