Metadata-Version: 2.1
Name: foxglove-schemas-flatbuffer
Version: 0.2.0
Summary: Flatbuffer classes for Foxglove Schemas
Home-page: https://github.com/foxglove/schemas
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: flatbuffers

# Foxglove Schemas (Flatbuffer)

This package provides [Flatbuffer](https://google.github.io/flatbuffers/) classes for [Foxglove Schemas](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction).

## Installation

Install via [Pipenv](https://pipenv.pypa.io/en/latest/) by adding `foxglove-schemas-flatbuffer` to your `Pipfile` or via the command line:

```bash
pipenv install foxglove-schemas-flatbuffer
```

## Usage

Import types from the `foxglove_schemas_flatbuffer` module as follows:

```py
import flatbuffers
import foxglove_schemas_flatbuffer.CompressedImage as CompressedImage
from foxglove_schemas_flatbuffer import get_schema

builder = flatbuffers.Builder(1024)
png = builder.CreateString("png")
CompressedImage.Start(builder)
CompressedImage.AddFormat(builder, png)
img = CompressedImage.End(builder)
builder.Finish(img)

# Serialized flatbuffer schema
schema_data = get_schema("CompressedImage")

# Serialized CompressedImage message
msg_data = builder.Output()
```

## Stay in touch

Join our [Slack channel](https://foxglove.dev/slack) to ask questions, share feedback, and stay up to date on what our team is working on.
