https://github.com/brechin/pyrollout

Python feature flagging
https://github.com/brechin/pyrollout

Last synced: 2 months ago
JSON representation

Python feature flagging

• Host: GitHub
• URL: https://github.com/brechin/pyrollout
• Owner: brechin
• License: mit
• Created: 2015-06-08T02:32:00.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-21T15:13:13.000Z (over 7 years ago)
• Last Synced: 2024-09-23T02:08:24.340Z (4 months ago)
• Language: Python
• Size: 206 KB
• Stars: 5
• Watchers: 5
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# pyrollout

Python feature flagging

[![Build Status](https://travis-ci.org/brechin/pyrollout.svg?branch=master)](https://travis-ci.org/brechin/pyrollout)

[![PyPI Version](https://img.shields.io/pypi/v/pyrollout.svg?style=flat-square)](https://pypi.python.org/pypi/pyrollout/)

[![PyPI Popularity](https://img.shields.io/pypi/dm/pyrollout.svg?style=flat-square)](https://pypi.python.org/pypi/pyrollout/)

[![Code Climate](https://codeclimate.com/github/brechin/pyrollout/badges/gpa.svg)](https://codeclimate.com/github/brechin/pyrollout)

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

Inspired by the [rollout](https://github.com/FetLife/rollout) Ruby gem by [James Golick](https://github.com/jamesgolick)

and a Python port of it called

[proclaim](https://github.com/asenchi/proclaim) by [Curt Micol](Curt Micol) which I found after reading

[Using Feature Flags to Ship Changes with Confidence](http://blog.travis-ci.com/2014-03-04-use-feature-flags-to-ship-changes-with-confidence/)

by [Mathias Meyer](https://github.com/roidrage).

Both of these use redis, and I don't like that requirement. I seek to support multiple storage/persistence mechanisms.

Usage

-----

To initialize pyrollout with the default in-memory feature & user storage:

```python

import pyrollout

rollout = pyrollout.Rollout()

```

Now add features:

```python

from pyrollout.feature import Feature

# Open to all by using the special group 'ALL'

rollout.add_feature(Feature('feature_for_all', groups=['ALL']))

# Open to select groups

rollout.add_feature(Feature('feature_for_groups', groups=['vip', 'early_adopter]))

# Open to specific user(s), by user ID

rollout.add_feature(Feature('feature_for_users', users=[123, 456, 789]))

# Open to 20% of users, calculated via user ID

rollout.add_feature(Feature('20pct', percentage=20))

```

Check access to features:

```python

def untested_feature(user):

    # Because this feature was not defined, access will always be denied (by default)

    if not rollout.can(user, 'use_untested_feature'):

        return None

    else:

        do_cool_things()

class FooHandler(BaseHandler):

    def get(self):

        # self.user is a user object in a format pyrollout understands

        if not rollout.can(self.user, 'feature_for_users'):

            self.abort(403)

        else:

            do_foo()

```

Some feature ideas

------------------

* Flag on user property

* Flag on lambda passed the user object

* Use file

* Use memcache, e.g. in Google App Engine

* Use some other persistent database