dinobytes 0.2.0

No project description provided

DinoBytes

DinoBytes is a dynamic serialization framework designed to simplify network communication by providing a robust set of tools for serializing and deserializing messages using the MessagePack format. With its easy-to-use decorator and base class, DinoBytes makes defining and handling network messages both efficient and intuitive, suitable for applications ranging from simple messaging systems to complex distributed architectures.

Features

• Automatic Message Type Registration: Utilizes a decorator to automatically register message types and assign unique identifiers, ensuring a smooth serialization and deserialization process.
• Simplified Serialization: Offers a straightforward method (to_bytes) for converting message objects into serialized bytes.
• Effortless Deserialization: Allows for easy conversion of bytes back into message objects using the from_bytes method, facilitating quick and reliable message parsing.
• Streamlined Message Definition: Leverages Python's dataclass decorator within the custom cerealbox decorator to reduce boilerplate and enhance readability when defining new message types.
• Message Registry: Automatically maintains a registry of message types, simplifying the process of managing different kinds of network messages within your application.

Installation

Install DinoBytes using pip:

pip install dinobytes

Quick Start

Defining a Message

from dinobytes import cerealbox

@cerealbox
class MyMessage:
    content: str

Serializing a Message

message = MyMessage(content="Hello, DinoBytes!")
serialized_message = message.to_bytes() # or bytes(message)

Deserializing a Message

received_message = MyMessage.from_bytes(serialized_message)
print(received_message.content)  # Output: Hello, DinoBytes!

The consume convenience method can also be used to automatically unpack into the correct type:

from dinobytes import consume

received_message = consume(serialized_message)
print(received_message.content)  # Output: Hello, DinoBytes!

Contributing

Contributions to DinoBytes are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to reach out or submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

License

DinoBytes is released under the Apache 2 License. See the LICENSE file for more details.