spackle-python 0.0.28

No project description provided

Spackle Python Library

The Spackle Python library provides optimized access to billing aware flags created on the Spackle platform.

Documentation

See the Python API docs.

Setup

Install the Spackle library

pip install -U spackle-python

Configure your environment

In order to use Spackle, you need to configure your API key on the spackle module. You can find your API key in Spackle app settings page.

import spackle
spackle.api_key = "<api key>"

Bootstrap the client (optional)

The Spackle client requires a single initialization step that includes a network request. To front load this process, you can call the bootstrap method in your codebase.

spackle.bootstrap()

Usage

Fetch a customer

Spackle uses stripe ids as references to customer features.

customer = spackle.Customer.retrieve("cus_00000000")

Verify feature access

customer.enabled("feature_key")

Fetch a feature limit

customer.limit("feature_key")

Logging

The Spackle Python library emits logs as it performs various internal tasks. You can control the verbosity of Spackle's logging a few different ways:

1. Set the environment variable SPACKLE_LOG to the value debug or info

   $ export SPACKLE_LOG=debug
   

2. Set spackle.log:

   import spackle
   spackle.log = 'debug'
   

3. Enable it through Python's logging module:

   import logging
   logging.basicConfig()
   logging.getLogger('spackle').setLevel(logging.DEBUG)