Skip to main content

python SDK for Molasses - feature flags as a service

Project description

https://raw.githubusercontent.com/molassesapp/molasses-go/main/logo.png

molasses-python

https://img.shields.io/pypi/v/molasses.svg

A Python SDK for Molasses. It allows you to evaluate user’s status for a feature. It also helps simplify logging events for A/B testing.

Molasses uses server sent events to get instant updates with an option for polling to check if you have updated features. Once initialized, it takes microseconds to evaluate if a user is active.

Install

pip install molasses

Usage

Initialization

Start by initializing the client with an APIKey. This begins the polling for any feature updates. The updates happen every 15 seconds.

from molasses import MolassesClient

client = MolassesClient("test_key")

If you decide not to track analytics events (experiment started, experiment success) you can turn them off by setting the send_events field to False

client = MolassesClient("test_key",  send_events=False)

Check if feature is active

You can call is_active with the key name and optionally a user’s information. The id field is used to determine whether a user is part of a percentage of users. If you have other constraints based on user params you can pass those in the params field.

client.is_active("FOO_TEST", {
  "id":"foo",
  "params":{
    "isBetaUser":"false",
    "isScaredUser":"false"
   }
})

You can check if a feature is active for a user who is anonymous by just calling is_active with the key. You won’t be able to do percentage roll outs or track that user’s behavior.

client.is_active("TEST_FEATURE_FOR_USER")

Experiments

To track an analytics events called the track method.

client.track("Button Clicked",{
   "id":"foo",
   "params":{
     "isBetaUser":"false",
     "isScaredUser":"false"
    }
 },
 {
   "version": "v2.3.0"
})

To track whether an experiment was successful you can call experiment_started. experiment_started takes the feature’s name, any additional parameters for the event and the user.

client.experiment_started("GOOGLE_SSO",{
   "id":"foo",
   "params":{
     "isBetaUser":"false",
     "isScaredUser":"false"
    }
 },
 {
   "version": "v2.3.0"
})

To track whether an experiment was successful you can call experiment_success. experiment_success takes the feature’s name, any additional parameters for the event and the user.

client.experiment_success("GOOGLE_SSO",{
   "id":"foo",
   "params":{
     "isBetaUser":"false",
     "isScaredUser":"false"
    }
 },
 {
   "version": "v2.3.0"
})

Example

from molasses import MolassesClient

client = MolassesClient("test_key")

if client.is_active('NEW_CHECKOUT'):
  print "we are a go"
else:
  print "we are a no go"

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-09-24)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

molasses-0.3.1.tar.gz (14.5 kB view hashes)

Uploaded Source

Built Distribution

molasses-0.3.1-py2.py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page