Feature flags for Wagtail sites
Project description
Wagtail-Flags
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.
- Dependencies
- Installation
- Usage
- Extended conditions
- Signals
- Getting help
- Getting involved
- Licensing
- Credits and references
Dependencies
- Python 3.8+
- Django 3.2 (LTS)+
- Django-Flags 4.2
- Wagtail 4.0+
It should be compatible at all intermediate versions, as well. If you find that it is not, please file an issue.
Installation
- Install Django-Flags and Wagtail-Flags:
pip install django-flags
pip install wagtail-flags
- Add
flagsandwagtailflagsas installed apps in your Djangosettings.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":
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'}
],
}
Signals
Wagtail-Flags includes flag_enabled and flag_disabled signals that can be received when the "Enable for all requests" and "Disable for all requests" buttons are pressed in the admin. This is intended to enable things like front-end cache invalidation.
from django.dispatch import receiver
from wagtail.contrib.frontend_cache.utils import purge_url_from_cache
from wagtailflags.signals import flag_disabled, flag_enabled
@receiver(flag_enabled)
def purge_on_flag_enabled(sender, **kwargs):
flag_name = kwargs["flag_name"]
purge_url_from_cache(...)
@receiver(flag_disabled)
def purge_on_flag_disabled(sender, **kwargs):
flag_name = kwargs["flag_name"]
purge_url_from_cache(...)
Please note: These signals are only sent for manual presses of the "Enable for all requests" and "Disable for all requests" buttons in the admin. Other flag conditions may vary within and only be valid for a specific request cycle.
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 history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtail_flags-5.3.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 97f964ce5e90b1d93b7a258f8d8993cd8b5c2b9002b331207fc6ba8b5bee2d09 |
|
| MD5 | 857e31fd3f23aa4a30bbc5c35af244d1 |
|
| BLAKE2b-256 | bb1795a191cc985f0795bfe73fafa34d733a60f706906fe94ccb3e506564ab58 |
