Provides a Python wrapper around the BrainFrame REST API.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aotooling from gravatar.com aotooling Avatar for stephenli200 from gravatar.com stephenli200

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD-3-Clause)
  • Author: Aotu
  • Requires: Python >=3.6, <4.0
Classifiers
Report project as malware

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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page