Feature flags for Django projects
Clone or download

README.md

Django-Flags

Build Status Coverage Status

Feature flags allow you to toggle functionality in both Django code and the Django templates based on configurable conditions. Flags can be useful for staging feature deployments, for A/B testing, or for any time you need an on/off switch for blocks of code. The toggle can be by date, user, URL value, or a number of other conditions, editable in the admin or in definable in settings.

Dependencies

  • Django 1.8+ (including Django 2.0)
  • Python 2.7+, 3.6+

Installation

  1. Install Django-Flags:
pip install django-flags
  1. Add flags as an installed app in your Django settings.py:
INSTALLED_APPS = (
    ...
    'flags',
    ...
)

Documentation

https://cfpb.github.io/django-flags is the full documentation for Django-Flags, and includes how to get started, general usage, and an API reference.

Getting help

Please add issues to the issue tracker.

Getting involved

General instructions on how to contribute can be found in CONTRIBUTING.

Licensing

  1. TERMS
  2. LICENSE
  3. CFPB Source Code Policy

Credits and references

Django-Flags was forked from Wagtail-Flags, which was itself forked from cfgov-refresh.