Wagtail-Flags

Feature flags allow you to toggle functionality in the Wagtail based on configurable conditions.

Wagtail-Flags adds a Wagtail admin UI and Wagtail Site-based condition on top of Django-Flags. For a more complete overview of feature flags and how to use them, please see the Django-Flags documentation.

Feature flags in the Wagtail admin

Dependencies
Installation
Usage
Extended conditions
Getting help
Getting involved
Licensing
Credits and references

Dependencies

Django 1.8+ (including Django 2.0)
Wagtail 1.10+ (including Wagtail 2.0)
Django-Flags 3.0+
Python 2.7+, 3.6+

Installation

Install wagtail-flags:

pip install wagtail-flags

Add flags and wagtailflags as installed apps in your Django settings.py:

INSTALLED_APPS = (
    ...
    'flags',
    'wagtailflags',
    ...
)

Usage

Please see the Django-Flags documentation for the most current information about defining and checking feature flags.

First, define the flag in Django settings.py:

FLAGS = {
    'MY_FLAG': {}
}

Then use the flag in a Django template (mytemplate.html):

{% load feature_flags %}
{% flag_enabled 'MY_FLAG' as my_flag %}

{% if my_flag %}
  <div class="flagged-banner">
    I’m the result of a feature flag.   
  </div>
{% endif %}

Next, configure a URL for that template (urls.py):

from django.urls import path
from django.views.generic import TemplateView

urlpatterns = [
    path(r'mypage/', TemplateView.as_view(template_name='mytemplate.html')),
]

Finally, add conditions for the flag in the Wagtail admin under "Settings", "Flags":

Creating conditions in the Wagtail admin

Extended conditions

Wagtail-Flags adds the following conditions to Django-Flags:

`site`

Allows a flag to be enabled for a Wagtail site that matches the hostname and port in the condition value.

FLAGS = {'MY_FLAG': {'site': 'staging.mysite.com'}}

Getting help

Please add issues to the issue tracker.

Getting involved

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

Licensing

Credits and references

Forked from cfgov-refresh

Release files for wagtail-flags 3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtail-flags 3.0.1
File	Size	Uploaded
wagtail-flags-3.0.1.tar.gz	10.2 kB	Aug 29, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for wagtail-flags 3.0.1
File	Interpreter	ABI	Platform	Reset
wagtail_flags-3.0.1-py2.py3-none-any.whl 10.2 kB Aug 29, 2018	Python 3, Python 2	none	any	Details

Total release size:20.3 kB

Release files / wagtail-flags-3.0.1.tar.gz

Download URL	wagtail-flags-3.0.1.tar.gz
Size	10.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`dcac4432ce83a4bc54538859e3057f069095924575cdcde5da19004169eb9f4b`
BLAKE2b-256 checksum How to use checksums	`72e8172d461dea7261321c544121d7d8af8d4481f7b42f62885ffbe4ae93502d`
Upload date	Aug 29, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.0 CPython/3.6.4`

Release files / wagtail_flags-3.0.1-py2.py3-none-any.whl

Download URL	wagtail_flags-3.0.1-py2.py3-none-any.whl
Size	10.2 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`08f2bd4056eca641b13bc83a07a0dae67fcc9d81aaa42f0b3ad95eda4ae6a3e2`
BLAKE2b-256 checksum How to use checksums	`b1dee36ed22c8be5e9f765216d8af9b31d334916c020add50fd1c14546987283`
Upload date	Aug 29, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.0 CPython/3.6.4`