https://github.com/cfpb/django-flags

Feature flags for Django projects
https://github.com/cfpb/django-flags

django feature-flags feature-flipper feature-toggles hacktoberfest python

Last synced: 3 months ago
JSON representation

Feature flags for Django projects

• Host: GitHub
• URL: https://github.com/cfpb/django-flags
• Owner: cfpb
• License: cc0-1.0
• Created: 2018-06-16T15:23:55.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-05T16:55:24.000Z (4 months ago)
• Last Synced: 2024-08-08T20:56:36.525Z (3 months ago)
• Topics: django, feature-flags, feature-flipper, feature-toggles, hacktoberfest, python
• Language: Python
• Homepage: https://cfpb.github.io/django-flags/
• Size: 6.9 MB
• Stars: 248
• Watchers: 26
• Forks: 28
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - cfpb/django-flags - Feature flags for Django projects (Python)

README

        
# Django-Flags

[![Build Status](https://github.com/cfpb/django-flags/workflows/test/badge.svg)](https://github.com/cfpb/django-flags/actions)

[![Ethical open source](https://img.shields.io/badge/ethical-open-%23bb8c3c?labelColor=393162)](https://ethicalsource.dev/principles/)

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

- Python 3.8+

- Django 4.2+

## 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).