Metadata-Version: 2.1
Name: jomiel_messages
Version: 0.2.0
Summary: Python bindings for jomiel protobuf messages
Home-page: https://github.com/guendto/jomiel-messages
Author: Toni Gündoğdu
Author-email: 47444442+guendto@users.noreply.github.com
License: Apache2.0
Description: # jomiel-messages
        
        [![pypi-pyversions](https://img.shields.io/pypi/pyversions/jomiel-messages?color=%230a66dc)][pypi]
        [![pypi-v](https://img.shields.io/pypi/v/jomiel-messages?color=%230a66dc)][pypi]
        [![pypi-wheel](https://img.shields.io/pypi/wheel/jomiel-messages?color=%230a66dc)][pypi]
        [![pypi-status](https://img.shields.io/pypi/status/jomiel-messages?color=%230a66dc)][pypi]
        [![code-style](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
        
        [pypi]: https://pypi.org/project/jomiel-messages
        [black]: https://pypi.org/project/black
        
        The Python bindings for the [jomiel] protobuf messages.
        
        ## About
        
        The purpose of this project is to provide the [jomiel] protobuf message
        bindings package that are `easy to install` from PyPI. The bundled have
        been generated from the protobuf declaration files of [jomiel-proto].
        
        ## Installation
        
        ```shell
        pip install jomiel-messages
        ```
        
        ## Usage
        
        Serialize an inquiry message:
        
        ```python
        from jomiel_messages.protobuf.v1alpha1.message_pb2 import Inquiry
        
        inquiry = Inquiry()
        inquiry.media.input_uri = 'https://foo.bar/baz'
        serialized_string = Inquiry.SerializeToString(inquiry)
        # ...
        ```
        
        De-serialize a response message:
        
        ```python
        from jomiel_messages.protobuf.v1alpha1.message_pb2 import Response
        from jomiel_messages.protobuf.v1alpha1.status_pb2 import STATUS_CODE_OK
        
        response = Response()
        response.ParseFromString(serialized_string)
        
        if response.status.code != STATUS_CODE_OK:
          print(f"message={response.status.message})
          print(f"status-code={response.status.code}")
          print(f"error-code={response.status.error}")
          print(f"http-code={response.status.http.code}")
          # ...
        else:
          # ...
        ```
        
        ## Building packages from repo
        
        ```shell
        git clone https://github.com/guendto/jomiel-messages
        cd jomiel-messages
        ./bin/gen
        git tag -s KEYID -am 'jomiel-messages version VERSION (INITIALS)' TAGNAME
        pip install pep517
        python -m pep517.build [-s|-b] .
        ```
        
        The packages are created under the dist/ dir.
        
        ## License
        
        `jomiel-messages` is licensed under the [Apache License version
        2.0][aplv2].
        
        ## Acknowledgements
        
        ### Subprojects (as git subtrees)
        
        - [src/jomiel_messages/proto/](src/jomiel_messages/proto/) of [jomiel-proto]
        
        [jomiel-proto]: https://github.com/guendto/jomiel-proto/
        [jomiel]: https://github.com/guendto/jomiel
        [aplv2]: https://www.tldrlegal.com/l/apache2
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
