Skip to main content

Renity Pure Python Protocol Buffer

Project description

Renity Protocol Buffer

PyPI Status Python Version License

Read the documentation at https://Renity.readthedocs.io/ Tests Codecov

pre-commit Black

There are many ways to optimize data transimission over the wire, but one of the biggest impacts can be made from simply not sending data you don't need. Renity provides an Interface for rapidly defining the serialization format for Network Traffic solely in Python. Using Schema's that closely resemble an Object Relational Mapping(ORM) we are able to generate simple class definitions that contain fields and methods to serlialze/parse to and from raw bytes.

Advantages

  • Extendable
  • Backward Compatible Schema(s)
  • Fast Parsing
  • strict enforcement at the application level(optional)
  • Optimize size of transmissions

Example

    class CustomMessage(Message):
        hello=StringField(default="World")
        sentence=ListField(StringField(required=True),IntField())

    example = CustomMessage({"sentence": ["Number of Apples:", 2]})

    print(example.message)

    Output:
        {"hello": "World", "sentence": ["Number of Apples:", 2]}

Features

  • TODO

Requirements

  • TODO

Installation

You can install Renity via pip from PyPI:

$ pip install renity

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Renity is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

renity-2.0.5.tar.gz (18.3 kB view hashes)

Uploaded Source

Built Distribution

renity-2.0.5-py3-none-any.whl (24.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page