brainframe-api

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.

pip3 install brainframe-api==0.26.0

Documentation

Documentation for this library is available on ReadTheDocs.

Project details

Release history Release notifications | RSS feed

0.30.0

Feb 1, 2022

0.29.1

Sep 24, 2021

0.29.0

Sep 22, 2021

0.28.2

Jul 1, 2021

0.28.1

Apr 22, 2021

0.28.0

Dec 16, 2020

0.27.0

Nov 14, 2020

0.27.0.dev2 pre-release

Nov 14, 2020

0.27.0.dev1 pre-release

Aug 12, 2020

0.26.2.dev2 pre-release

Aug 12, 2020

0.26.1

Aug 5, 2020

0.26.1.dev1 pre-release

Aug 4, 2020

0.26.0

Jul 30, 2020

0.26.0.dev20 pre-release

Jul 19, 2020

0.26.0.dev19 pre-release

Jul 11, 2020

0.26.0.dev18 pre-release

Jul 10, 2020

0.26.0.dev12 pre-release

Jul 2, 2020

0.26.0.dev11 pre-release

Jun 27, 2020

0.26.0.dev10 pre-release

Jun 24, 2020

This version

0.26.0.dev9 pre-release

Jun 24, 2020

0.26.0.dev8 pre-release

Jun 24, 2020

0.26.0.dev5 pre-release

Jun 15, 2020

0.26.0.dev4 pre-release

Jun 12, 2020

0.26.0.dev3 pre-release

Jun 11, 2020

0.26.0.dev2 pre-release

Jun 10, 2020

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.26.0.dev9.tar.gz (31.1 kB view details)

Uploaded Jun 24, 2020 Source

Built Distribution

brainframe_api-0.26.0.dev9-py3-none-any.whl (40.6 kB view details)

Uploaded Jun 24, 2020 Python 3

File details

Details for the file brainframe-api-0.26.0.dev9.tar.gz.

File metadata

Download URL: brainframe-api-0.26.0.dev9.tar.gz
Upload date: Jun 24, 2020
Size: 31.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for brainframe-api-0.26.0.dev9.tar.gz
Algorithm	Hash digest
SHA256	`a77fbd168b36157fc3ad5d90a7d0de8d64bc7bb2f97e6ae8484f8f42cd3f6ed6`
MD5	`7cc9aa8a76a3f4548df9f7d041c77694`
BLAKE2b-256	`123a9907eb22861e91572ccdbb555bdee2ad8c2abaf0b13c2eec2db86e60bbe6`

See more details on using hashes here.

File details

Details for the file brainframe_api-0.26.0.dev9-py3-none-any.whl.

File metadata

Download URL: brainframe_api-0.26.0.dev9-py3-none-any.whl
Upload date: Jun 24, 2020
Size: 40.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for brainframe_api-0.26.0.dev9-py3-none-any.whl
Algorithm	Hash digest
SHA256	`1bc7125c00eddd0c664c42b8381f5a25cf74011158597f8fa16a7100dc06976f`
MD5	`d4ac2787ad596ad44681c5139fe6c977`
BLAKE2b-256	`5a608575f508036a019bb78663c3aef842d5fdf3b62ee384b97ea77d6fe56172`