zserio 2.1.0rc2

Zserio runtime and Python package generator.

Zserio Package

PyPI package infrastructure around the zserio serialization framework. For extensive documentation regarding zserio, please check zserio.org.

Installation

Just run

pip3 install zserio

Alternatively, clone this repository, and run

./get.sh --python-module --version <desired-zserio-version>
pip3 install -e .

Importing zserio package sources

import zserio

# Automatically inserts a new python module called `mypackage`
#  into the current python environment
zserio.generate("mypackage/all.zs", "mypackage")

# You can now access structs from your zserio sources!
from mypackage.all import CoolStruct

Running tests

Just execute

pytest test

Available scripts:

get.sh [--python-module] [--version] [--directory]

Set the zserio artifact version under a specific destination path (or ./current/zserio, if no destination is given) to a desired version. If the version has not been added to ./cache, it will be downloaded and placed there. You should git add/push it.

The script places the following files under <directory>:

• runtime/
  • cpp/...
  • java/...
  • python/...
• zserio.jar
• version.txt
• [if --python-module]: patched python runtime sources

download.sh <version>

Use this if you just want to add a new zserio version to the cache (This is also triggered by get.sh if a non-cached version is requested).

Dockerfile

The Dockerfile may be used to work with this repository on Windows, e.g. to deploy a new version of the zserio pip package.