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(
    bf_codecs.StreamConfiguration(
        name="New Stream",
        connection_type=bf_codecs.ConnType.IP_CAMERA,
        connection_options={"url": "rtsp://192.168.1.100"},
        runtime_options={},
    ))
api.start_analyzing(stream_config.id)
# Get results
analysis_results = api.get_latest_zone_statuses()

Installation

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==0.26.1

Documentation

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.

Files for brainframe-api, version 0.26.1
Filename, size File type Python version Upload date Hashes
Filename, size brainframe_api-0.26.1-py3-none-any.whl (41.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size brainframe-api-0.26.1.tar.gz (32.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page