Feature flags for Django projects
Project description
# Django-Flags
[](https://travis-ci.org/cfpb/django-flags)
[](https://coveralls.io/github/cfpb/django-flags?branch=master)
Feature flags allow you to toggle functionality in both Django code and the Django templates based on configurable conditions. Flags can be useful for staging feature deployments, for A/B testing, or for any time you need an on/off switch for blocks of code. The toggle can be by date, user, URL value, or a number of [other conditions](https://cfpb.github.io/django-flags/conditions/), editable in the admin or in definable in settings.
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Documentation](#documentation)
- [Getting help](#getting-help)
- [Getting involved](#getting-involved)
- [Licensing](#licensing)
- [Credits and references](#credits-and-references)
## Dependencies
- Django 1.8+ (including Django 2.0)
- Python 2.7+, 3.6+
## Installation
1. Install Django-Flags:
```shell
pip install django-flags
```
2. Add `flags` as an installed app in your Django `settings.py`:
```python
INSTALLED_APPS = (
...
'flags',
...
)
```
## Documentation
https://cfpb.github.io/django-flags is the full documentation for Django-Flags, and includes how to get started, general usage, and an API reference.
## Getting help
Please add issues to the [issue tracker](https://github.com/cfpb/django-flags/issues).
## Getting involved
General instructions on _how_ to contribute can be found in [CONTRIBUTING](CONTRIBUTING.md).
## Licensing
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
## Credits and references
Django-Flags was forked from [Wagtail-Flags](https://github.com/cfpb/wagtail-flags), which was itself forked from [cfgov-refresh](https://github.com/cfpb/cfgov-refresh).
[](https://travis-ci.org/cfpb/django-flags)
[](https://coveralls.io/github/cfpb/django-flags?branch=master)
Feature flags allow you to toggle functionality in both Django code and the Django templates based on configurable conditions. Flags can be useful for staging feature deployments, for A/B testing, or for any time you need an on/off switch for blocks of code. The toggle can be by date, user, URL value, or a number of [other conditions](https://cfpb.github.io/django-flags/conditions/), editable in the admin or in definable in settings.
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Documentation](#documentation)
- [Getting help](#getting-help)
- [Getting involved](#getting-involved)
- [Licensing](#licensing)
- [Credits and references](#credits-and-references)
## Dependencies
- Django 1.8+ (including Django 2.0)
- Python 2.7+, 3.6+
## Installation
1. Install Django-Flags:
```shell
pip install django-flags
```
2. Add `flags` as an installed app in your Django `settings.py`:
```python
INSTALLED_APPS = (
...
'flags',
...
)
```
## Documentation
https://cfpb.github.io/django-flags is the full documentation for Django-Flags, and includes how to get started, general usage, and an API reference.
## Getting help
Please add issues to the [issue tracker](https://github.com/cfpb/django-flags/issues).
## Getting involved
General instructions on _how_ to contribute can be found in [CONTRIBUTING](CONTRIBUTING.md).
## Licensing
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
## Credits and references
Django-Flags was forked from [Wagtail-Flags](https://github.com/cfpb/wagtail-flags), which was itself forked from [cfgov-refresh](https://github.com/cfpb/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
django-flags-4.0.1.tar.gz
(18.6 kB
view hashes)
Built Distribution
Close
Hashes for django_flags-4.0.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a344fb8daaa87a35edfe620394ddb41ac7447dff08141721eb7e6d322a85b66c |
|
| MD5 | 288a97a30314a76da22b1851e29bfa58 |
|
| BLAKE2b-256 | fd8118fb55cdec82097ae07f41e636d5c57697f1865272f9f66c85cd6489aaaf |
