sob 2.2.0

A type-enforced framework for serializing and deserializing JSON

sob

sob is an object serialization/deserialization library intended to facilitate automated authoring of models for JSON web APIs which are readable and introspective, and to expedite data validation and integration testing.

• Documentation
• Contributing

Installation

You can install sob with pip:

pip3 install sob

Background Information

This library is developed in concert with, and in support of, the oapi library, which facilitates generating client libraries ("SDKs") based on an Open API specification. For very niche use cases, sob remains a separate library, but the development roadmap and all feature requests should be viewed in the context of supporting the definition and validation of data as described by an Open API specification.

When authoring server-side code for your web API, I recommend pydantic. The sob library is designed primarily to support API client data models, and for automated model module creation based on metadata generated either using sob.thesaurus or oapi.

The name "sob" is not a profane acronym (in this case), it is a portmanteau of "serial" and "object". Originally, this library was named "serial", but was renamed with version 1 due to a namespace conflict with pyserial.