Protobuf definitions converted to python classes for use in `fameio`
Project description
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
, and
Installation instructions
Use this Maven dependency:
<dependency>
<groupId>de.dlr.gitlab.fame</groupId>
<artifactId>protobuf</artifactId>
<version>2.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 fame@dlr.de before contributing.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fameprotobuf-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ceed3fca180902f30a63ecf09ee86d099d3768e6b272e71b995b31fafeb1ab5 |
|
MD5 | f9b7837be0e74cc1fa53a5e8f1621111 |
|
BLAKE2b-256 | 7258d9a98ba62c4ff9499f994fa3389b6537a3860b7092d778b8104617c7adc5 |