Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miare-ir/unleash-django
Utilities for using Unleash in Django apps
https://github.com/miare-ir/unleash-django
django feature-flags feature-toggles unleash
Last synced: 5 days ago
JSON representation
Utilities for using Unleash in Django apps
- Host: GitHub
- URL: https://github.com/miare-ir/unleash-django
- Owner: miare-ir
- License: mit
- Created: 2022-05-15T13:45:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-24T12:29:43.000Z (over 2 years ago)
- Last Synced: 2024-04-29T10:47:11.743Z (7 months ago)
- Topics: django, feature-flags, feature-toggles, unleash
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 12
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unleash-django
[](https://pypi.org/project/unleash-django-util/) [](https://pypi.org/project/unleash-django-util/)
This library is a wrapper for Unleash.io's [python](https://docs.getunleash.io/sdks/python_sdk)
It can wrap views and methods to run if only feature is enabled and return a fallback function
otherwise.
## Installation
```bash
$ pip install unleash-django-util
```
## Setting:
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'
## Use in Test Env:
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.
## Wrappers:
### Using view wrapper:
```python
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"""
```
### Using method wrapper:
```python
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
## Methods:
### is_enabled:
```python
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`.
### get_variant:
```python
from unleash_django.api.method import get_variant
get_variant('feature_name', context={'userId': '123'})
```
the result should be like:
```json lines
{
"name": "variant1",
"payload": {
"type": "string",
"value": "val1"
},
"enabled": True
}
```
### with_feature_flag:
```python
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`
## Change Log
### 0.4.4
* add a variable for fake initialization
### 0.4.3
* set level of logging
### 0.4.1
* added `get_variant` function