This library is a wrapper for Unleash.io's python
It can wrap views and methods to run if only feature is enabled and return a fallback function otherwise.
$ pip install unleash-django-util
set following values in your settings:
* UNLEASH_API_TOKEN = 'your project token',default is 'default:development. unleash-insecure-api-token'
* UNLEASH_URL = 'the project url', default is 'https://app.unleash-hosted.com/demo/api/'
* UNLEASH_APP_NAME = 'the app name', default is 'miare'
set UNLEASH_FAKE_INITIALIZE = True
in settings if no initialization is needed. By doing so no request is sent to Unleash server, neither for fetching flag status nor submitting metrics.
from unleash_django.decorators.view_flag import view_flag
def fallback_func(self):
"""some code goes here"""
@view_flag('feature_name', fallback_func)
def get(self):
"""some code here"""
from unleash_django.decorators.method_flag import method_flag
def fallback_func():
""" some code goes here """
@method_flag('feature_name', user_id=123)
def method():
""" some code goes here """
if a method feature flag is going to have a user based strategy, user_id
should be provided
from unleash_django.api.method import is_enabled
is_enabled('feature_name', context={'userId': '123'})
if feature flag is on, True
will be returned, otherwise False
unless default
is set to
True
.
from unleash_django.api.method import get_variant
get_variant('feature_name', context={'userId': '123'})
the result should be like:
{
"name": "variant1",
"payload": {
"type": "string",
"value": "val1"
},
"enabled": True
}
from unleash_django.api.method import with_feature_flag
def enabled_func():
"""some code goes here"""
def disabled_func():
"""some code goes here"""
with_feature_flag('feature_name', enabled_function=enabled_func, disabled_function=disabled_func)
It runs enabled_function
if feature is on, otherwise disabled_function
unless default
value is set to True
it is possible to pass functions with args and kwargs using tuple, dict or FlagFunction
- add a variable for fake initialization
- set level of logging
- added
get_variant
function