Skip to main content

Feature flags for Wagtail sites

Project description

Wagtail-Flags

Build Status Coverage Status

Feature flags allow you to toggle functionality 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

  • Python 3.6, 3.8
  • Django 1.11, 2.0, 2.2
  • Wagtail 1.13, 2.3, 2.8
  • Django-Flags 4.2+

It should be compatible at all intermediate versions, as well. If you find that it is not, please file an issue.

Installation

  1. Install Django-Flags and Wagtail-Flags:
pip install django-flags
pip install wagtail-flags
  1. 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", "MY_FLAG":

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': [
        {'condition': 'site', 'value': '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

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

Credits and references

  1. Forked from cfgov-refresh

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail-flags-4.1.1.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

wagtail_flags-4.1.1-py2.py3-none-any.whl (20.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wagtail-flags-4.1.1.tar.gz.

File metadata

  • Download URL: wagtail-flags-4.1.1.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for wagtail-flags-4.1.1.tar.gz
Algorithm Hash digest
SHA256 2c393749f64280108f4698a55eb0918f2c071f676450381d2cb1134cd05c88ea
MD5 a5abc50ae57a12af87a46d9f86a1e981
BLAKE2b-256 b91be942a152017c8de4edbb3a87b84bd8582676a7658176c8dd81b9531ab941

See more details on using hashes here.

Provenance

File details

Details for the file wagtail_flags-4.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: wagtail_flags-4.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for wagtail_flags-4.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b424e91593f14e67e30ea0429e4eafa1371dfcf58cc38f9c0d480da49aa23c4b
MD5 a60cf12e80e0329398aa1dee8987924b
BLAKE2b-256 fe0814fb3ac954ad7016c28b64070be234416395b5a612d765a0c387aea9a4cf

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page