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.2.tar.gz
(19.0 kB
view details)
Built Distribution
File details
Details for the file django-flags-4.0.2.tar.gz.
File metadata
- Download URL: django-flags-4.0.2.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.0 CPython/3.6.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bb01279a5179aacc1e18d390fbdb1cadf0d1dfb8fd32e681ca54e47f45cf65d4 |
|
| MD5 | 09fbd7bac697a04b0f8bf3e9cad1f420 |
|
| BLAKE2b-256 | 7ec4f0a321a50a46b5ca570fe2ecb6c193ab83654e3c7a78ca03bd8a2d343820 |
Provenance
File details
Details for the file django_flags-4.0.2-py2.py3-none-any.whl.
File metadata
- Download URL: django_flags-4.0.2-py2.py3-none-any.whl
- Upload date:
- Size: 25.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.0 CPython/3.6.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 784f3f2017c0496407625af1ad272c43d694f0250bf1e342af5319673c9fc84c |
|
| MD5 | a012e039d87ca81fceb43db0225bf922 |
|
| BLAKE2b-256 | 581b5f94f0207a62254c0ebaf6b469fb50f419f8d74563cb6614b6e1e3b10d5a |
