Metadata-Version: 2.4
Name: colav-proto
Version: 0.0.1
Summary: A package for generation, serialization and deserialization of colav protobuf messages.
Project-URL: Documentation, https://github.com/Ryan/colav-proto#readme
Project-URL: Issues, https://github.com/Ryan/colav-proto/issues
Project-URL: Source, https://github.com/Ryan/colav-proto
Author-email: Ryan <r.mckee@qub.ac.uk>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: hatch
Requires-Dist: lark
Requires-Dist: numpy
Requires-Dist: protobuf
Requires-Dist: pytest
Requires-Dist: pyyaml
Requires-Dist: shapely
Description-Content-Type: text/markdown

# colav-proto

[![PyPI - Version](https://img.shields.io/pypi/v/colav-protobuf-utils.svg)](https://pypi.org/project/colav-proto)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/colav-protobuf-utils.svg)](https://pypi.org/project/colav-proto)

A project for generating, serializing and deserializing COLAV protobuf interfaces. Providing interfaces for generation of all the different protos required as well as different types and constants related.

-----

## Table of Contents

- [Installation](#installation)
- [Structure](#structure)
- [Usage](#usage)
- [License](#license)

## Installation

```bash
pip install colav-proto
```

## Structure

The source code in [colav_proto](https://github.com/RyanMcKeeQUB/colav-proto) is organized into the following main directories:


## Usage

Once the package has been installed into your environment, usage is simple.

### Imports

```python
```

### Sample Mission Request Creation

```python
```

### Sample Serialization

```python
serialized_msg = serialize_protobuf(mission_req_proto)
```

### Sample Deserialization

```python
deserialized_msg = deserialize_protobuf(serialized_msg)
```

## License

`colav-proto` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
