Metadata-Version: 1.0
Name: brainframe-api
Version: 0.26.0.dev3
Summary: Provides a Python wrapper around the BrainFrame REST API.
Home-page: https://github.com/aotuai/brainframe_python
Author: Aotu
Author-email: UNKNOWN
License: BSD-3-Clause
Description: =====================
        BrainFrame Python API
        =====================
        
        .. image:: https://readthedocs.org/projects/brainframe-python-api/badge/?version=latest
           :target: https://brainframe-python-api.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        
        .. image:: https://github.com/aotuai/brainframe_python/workflows/Publish%20package/badge.svg
           :target: https://github.com/aotuai/brainframe_python/actions
           :alt: Publish Packages CI Status
        
        This library is a Python wrapper around the BrainFrame REST API. It allows for
        easy interaction with a BrainFrame server.
        
        .. code-block:: python
        
           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.
        
        .. code-block:: bash
        
           pip3 install brainframe-api==0.26.0
        
        Documentation
        -------------
        
        Documentation for this library is available on `ReadTheDocs`_.
        
        .. _`ReadTheDocs`:
           https://brainframe-python-api.readthedocs.io/en/latest/
        
        
Platform: UNKNOWN
