https://github.com/thulasi-ram/django-feature-toggle

Feature Toggle implementation as a pluggable django app. Supports SimpleToggle, TimeBombToggle ways to manage release of new features that can be easily toggled on / off.
https://github.com/thulasi-ram/django-feature-toggle

django feature feature-toggles python switch toggles

Last synced: about 2 months ago
JSON representation

Feature Toggle implementation as a pluggable django app. Supports SimpleToggle, TimeBombToggle ways to manage release of new features that can be easily toggled on / off.

• Host: GitHub
• URL: https://github.com/thulasi-ram/django-feature-toggle
• Owner: thulasi-ram
• License: gpl-3.0
• Created: 2017-09-20T08:34:11.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-11-11T09:34:24.000Z (over 3 years ago)
• Last Synced: 2025-03-26T19:51:17.657Z (2 months ago)
• Topics: django, feature, feature-toggles, python, switch, toggles
• Language: Python
• Homepage:
• Size: 1.77 MB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==============

Feature Toggle

==============

Feature Toggle is a simple Django app based on the behavioural pattern `Feature Toggle `_ proposed by Martin Fowler.

Quick links

===========

    PyPi: `https://pypi.org/project/django-feature-toggle/ `_

    Source: `https://github.com/thulasi-ram/django-feature-toggle `_

    Docs: `https://django-feature-toggle.readthedocs.io/en/latest/ `_

Quick start

===========

1. Install the package ``pip install django-feature-toggle``

2. Add "feature_toggle" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [

        ...

        'feature_toggle',

    ]

3. Run ``python manage.py migrate`` to create the models required feature_toggle.

4. Start your app to use the feature_toggle.

Quick Setup

===========

For people intrested in contributing:

1. Make a virtual environment

2. run ``python setup.py install`` or ``python3 setup.py install``

3. run ``pip install -r requirements.txt`` or ``pip3 install -r requirements.txt``

4. Make your changes and run tests by doing steps ``5`` and ``6``

5. ``git checkout py2_django_app`` and run ``python manage.py test`` make sure you have python 2 in your environment

6. ``git checkout py3_django_app`` and run ``python3 manage.py test`` make sure you have python 3 in your environment

7. ``5`` and ``6`` will be mitigated in the near future by tox or by using travis.

Generating Docs

===============

Handled by: https://readthedocs.org/projects/django-feature-toggle

Legacy

1. cd to ``docs\``

2. run ``make custom-gh-pages``

3. The current state of docs is a mix of ``gh-pages`` and ``wiki``

4. Docs are generated using sphinx. Generates files read from ``index.rst`` to ``_build`` directory.

5. ``make custom-gh-pages`` custom command copies ``_build`` to ``gh-pages`` directory and commits it which is used by github docs.