Feature Toggle¶
Feature Toggle is a simple Django app based on the behavioural pattern Feature Toggle proposed by Martin Fowler.
Quick links¶
Quick start¶
Install the package
pip install django-feature-toggle
Add “feature_toggle” to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [ ... 'feature_toggle', ]
Run
python manage.py migrate
to create the models required feature_toggle.Start your app to use the feature_toggle.
Quick Setup¶
For people intrested in contributing:
- Make a virtual environment
- run
python setup.py install
orpython3 setup.py install
- run
pip install -r requirements.txt
orpip3 install -r requirements.txt
- Make your changes and run tests by doing steps
5
and6
git checkout py2_django_app
and runpython manage.py test
make sure you have python 2 in your environmentgit checkout py3_django_app
and runpython3 manage.py test
make sure you have python 3 in your environment5
and6
will be mitigated in the near future by tox or by using travis.
Generating Docs¶
- cd to
docs\
- run
make custom-gh-pages
- The current state of docs is a mix of
gh-pages
andwiki
- Docs are generated using sphinx. Generates files read from
index.rst
to_build
directory. make custom-gh-pages
custom command copies_build
togh-pages
directory and commits it which is used by github docs.