Skip to main content

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

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

Uploaded Source

Built Distribution

brainframe_api-0.26.0.dev2-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brainframe-api-0.26.0.dev2.tar.gz
  • Upload date:
  • Size: 25.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for brainframe-api-0.26.0.dev2.tar.gz
Algorithm Hash digest
SHA256 44059fc297ca2a747bba5b75e4e14c50734a259cd17d59c98bd2f95b57d19ab0
MD5 2c60308774c7cfd98ce2e5bf2cbb444e
BLAKE2b-256 744fced1a1a411ebd40af981091a43bb0010fb1bb858b766dca8eae74be54149

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brainframe_api-0.26.0.dev2-py3-none-any.whl
  • Upload date:
  • Size: 38.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.6.10

File hashes

Hashes for brainframe_api-0.26.0.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 e92285507a92a270cab9fce2b14683947c495e2aa5fc524a117b79f8ff30cb55
MD5 ce0aa031bb6429caa84aa086bfce420f
BLAKE2b-256 d69bd8602064c1e373b1df515ef8d58d28e0cc4bb8c8b53fdd54dac1adcaf7cf

See more details on using hashes here.

Supported by

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