Metadata-Version: 2.1
Name: zserio
Version: 2.1.0rc1
Summary: Zserio runtime and Python package generator.
Home-page: http://zserio.org
Author: Navigation Data Standard e.V.
Author-email: support@nds-association.org
License: BSD-3 Clause
Description: # Zserio Package
        
        PyPI package infrastructure around the zserio serialization framework.
        For extensive documentation regarding zserio, please check
        [zserio.org](http://zserio.org).
        
        ## Installation
        
        Just run
        
        ```bash
        pip3 install zserio
        ```
        
        Alternatively, clone this repository, and run
        
        ```bash
        ./get.sh --python-module --version <desired-zserio-version>
        pip3 install -e .
        ```
        
        ## Importing zserio package sources
        
        ```py
        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
        
        ```bash
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
