fameprotobuf 3.0.0

Protobuf definitions converted to python classes for use in `fameio`

FAME-Protobuf

Google Protocol Buffer (protobuf) definitions define the structure of binary input and output files for FAME applications. Please visit the Wiki for FAME to get an explanation of FAME and its components.

FAME-Protobuf connects FAME-Io to applications based on FAME-Core. Thus, both depend on FAME-Protobuf.

Repository

The repository is split into three source code parts:

• protobuf definitions reside in src/main/resources,
• derived Python classes for FAME-Io reside in src/main/python.
• derived Java classes for FAME-Core reside in target/generated-java-sources

Installation instructions

Use this Maven dependency:

<dependency>
  <groupId>de.dlr.gitlab.fame</groupId>
  <artifactId>protobuf</artifactId>
  <version>3.0.0</version>
</dependency>

Packaging

Compile

The pom.xml is configured to allow automated compilation of the protobuf definitions to Python and Java classes.

Maven build

In the cloned repository of fame-protobuf, compile and package fame-protobuf locally to your Maven repository:

mvn package

Deploy to PyPI

FAME-Protobuf is packaged to PyPI. We use poetry for packaging. Packaging requires these steps:

• install poetry: pip install poetry
• run the packaging script: python packaging.py
• build wheel: poetry build
• publish: poetry publish

Contribute

Please read the Contributors License Agreement (cla.md), sign it and send it to [e-mail] before contributing. Also, check CONTRIBUTING.md.