osef 3.4.0

Osef python library.

OSEF library

Library containing utilities to read and parse a stream, live or recorded, retrieved from Shift.

The stream is in the OSEF format (Open SErialization Format): it's an Outsight-defined serialisation binary format used to encode data streaming out of Shift. It is based on TLV-encoding.

For the full documentation, see: Developer documentation.
You can contact us @ https://support.outsight.ai

Installation

Install from PyPi using pip:

pip install osef

Usage

Open and parse an osef file or stream:

import osef

osef_path = "path/to/my/file.osef"
# or osef_path="tcp://192.168.2.2:11120"

for frame_dict in osef.parse(osef_path):
    print(frame_dict)

Additional parameters:

• first/last: the first and the last frame to parse
• auto_reconnect: enable parser auto_reconnection (default: True)
• real_frequency: If False, parse data as fast as your computer can. If True, process the data as the same pace as the real time stream from Shift (default: False)
• lazy: If lazy, the dict only unpack the values when they are accessed to save up resources (default: True)

To find more code samples, see Outsight Code Samples repository.

Development

1. The repository uses LFS to store some large OSEF samples for the tests. You need to install git-lfs and then run the following commands to get the files.

git lfs pull

2. Install project and dependencies.

• create and activate venv (python -m venv venv, then source venv/bin/activate)
• pip install -e . to install the project
• pip install -r test_requirements.txt to install dev dependencies (formatter, linter, unit tests dependencies)

3. Linting. Code is compatible with python 3.8+, pylint is set to ensure compatibility with python 3.8. To quickly run black + pylint,

./devops/local_lint.sh

4. Unit tests. We use pytest. Some tests might take time (about a couple of minutes)

pytest tests/