pylimiter 0.1.2

Limiter Python SDK

Limiter Python SDK

Installation

pip install pylimiter

Quick Usage

Default Backend

Initialize SDK with the managed storage backend

from pylimiter import limiter

opts = {
  backend: 'Default',
  api_token: 'api-token',
};
client = limiter.Client('project-id', opts);

Available Methods

# Bind user to a plan
client.bind('plan-name', 'user-id')

# Check if a feature is within limit
if client.feature('feature-name', 'user-id'):
  print('Pass')

# Increment usage by 1.
client.increment('feature-name', 'user-id')

# Decrement usage by 1.
client.decrement('feature-name', 'user-id')

# Set usage to some value.
client.set('feature-name', 'user-id', 5)

# Get feature matrix for the project
feature_matrix = client.feature_matrix()

# Get user's usage data
usage = client.usage('user-id')