README.md

Oblate — data, made easy

Oblate is a Python library that provides modern and robust interface for data and schema validation.

Focused around simplicity and flexibility, Oblate has the following features:

• Intuitive and modern object oriented interface
• Built in support for commonly used data structures
• Easily extendible and customizable to suit every use case
• Robust with no compromise on performance and speed
• Typed and plays well with static type checking

Documentation • Source Code • Python Package Index

Installation

Oblate is available on PyPi and can be installed using pip.

$ pip install oblate 

ℹ️ Didn't work? Try prefixing the above command with python -m if you don't have pip on PATH or the command doesn't work for some reason.

Usage

Oblate is focused around simplicity and ease of usage. Below snippet is an example of how data is handled using Oblate:

from oblate import validate, fields
import oblate


class Author(oblate.Schema):
    name = fields.String()  # Value should be of string data type
    bio = fields.String(none=True)  # Allows None to be passed

    # rating defaults to 0 if not provided and only allows values
    # between 0 to 10 (inclusive)
    rating = fields.Integer(default=0, validators=[validate.Range(0, 10)])

class Book(oblate.Schema):
    title = fields.String()
    price = fields.Float()

    # author takes the Author object (raw data or instance)
    author = fields.Object(Author)

data = {
    'title': 'Art of Data Validation',
    'price': 20.30,
    'author': {
        'name': 'John',
        'bio': None,
        'rating': 4,
    }
}
book = Book(data)
print(f"{book.title} by {book.author.name}")

Check the Quickstart section in documentation for an introduction to the basics of library.