Skip to main content

Provides a Python wrapper around the BrainFrame REST API.

Project description

Documentation Status Publish Packages CI Status

This library is a Python wrapper around the BrainFrame REST API. It allows for easy interaction with a BrainFrame server.

from brainframe.api import BrainFrameAPI, bf_codecs

# Connect to the server
api = BrainFrameAPI("http://localhost")
# Create a new IP camera stream
stream_config = api.set_stream_configuration(
        name="New Stream",
        connection_options={"url": "rtsp://"},
# Get results
analysis_results = api.get_latest_zone_statuses()


The BrainFrame Python API is available on PyPI and can be installed with pip. Install the version of the library that matches the version of BrainFrame that you are using. For example, if you are using BrainFrame version 0.26.1:

pip3 install brainframe-api


Documentation for this library is available on ReadTheDocs.

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

brainframe-api-0.30.0.tar.gz (29.7 kB view hashes)

Uploaded source

Built Distribution

brainframe_api-0.30.0-py3-none-any.whl (45.3 kB view hashes)

Uploaded py3

Supported by

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