testbolt 0.0.17

The Python Agent for testbolt

BOLT API Security

Secure Your API.

Installation

Currently BOLT's Python Agent supports 2 servers:

• Django
• Flask

It can be installed from pypi by running :

pip install testbolt

Configuration

Django

Once installed, Bolt's middleware can be added by modifying middlewares list (in the projects settings.py) like so:

MIDDLEWARE = [
    ...,
    "bolt.django.BoltDjango",
] 

and configuring a BOLT_CONFIG attribute in the projects settings.py like this :

BOLT_CONFIG = {
    "API_KEY": "<YOUR_BOLT_API_KEY>",
    "BOLT_HOST": "<YOUR_BOLT_COLLECTOR_URL>"
}

BOLT_CONFIG can take an optional key-value pair representing the max number of workers for communicating with Bolt.

Flask

Once installed, Bolt middleware can be added simply like:

from flask import Flask

...
from bolt.flask import BoltFlask

app = Flask(__name__)
BoltFlask(app, "<YOUR_BOLT_COLLECTOR_URL>", "<YOUR_BOLT_API_KEY>")

The Flask Middleware takes the flask app, Bolt collector url, and the Bolt API Key as parameters. As an optional parameter, a named value can be passed for max number of workers for communicating with Bolt.

BoltFlask(app, "<YOUR_BOLT_COLLECTOR_URL>", "<YOUR_BOLT_API_KEY>", workers="<WORKER-COUNT>")