Provides a Python wrapper around the BrainFrame REST API.
Project description
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-apiDocumentation
Documentation for this library is available on ReadTheDocs.
Release history Release notifications | RSS feed
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.28.2.tar.gz
(28.9 kB
view details)
Built Distribution
File details
Details for the file brainframe-api-0.28.2.tar.gz.
File metadata
- Download URL: brainframe-api-0.28.2.tar.gz
- Upload date:
- Size: 28.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.7 CPython/3.6.14 Linux/4.15.0-1103-aws
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ebf85cde31ed4d1158e930018cda0d246792b923fbf1251fb15e535a1899ce16 |
|
| MD5 | 0bbe4e6288bbbb2dd1231963289ac1d0 |
|
| BLAKE2b-256 | 3cbc433bec9568b13e6ffe57e04439fe2a23f78c4068994bfb881df37fac3fd9 |
File details
Details for the file brainframe_api-0.28.2-py3-none-any.whl.
File metadata
- Download URL: brainframe_api-0.28.2-py3-none-any.whl
- Upload date:
- Size: 43.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.7 CPython/3.6.14 Linux/4.15.0-1103-aws
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 93ff56b47aaf8e7558f044fd21a9df4de6f32a38915b0b6364ceeac889674719 |
|
| MD5 | 53f6ce90d9475bec291fc2fdfe227147 |
|
| BLAKE2b-256 | c77f8c3a4fc995a673f882b10f382d812f685f30eba566a99b35d2fa4d1a8910 |
