Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Travis:

https://img.shields.io/travis/rshk/contracts.svg

CircleCI:

https://img.shields.io/circleci/project/rshk/contracts.svg

Base library for defining lean “contract” models for Python.

Abstract

This is an implementation of “models” similar to those you see in most ORMs / forms definition systems, but with the main goal of keeping things as simple as possible.

No metaclasses or descriptors are involved; no hackish code messing up with standard Python objects functionality either.

The idea is to have a “layered” library, providing the bare bones needed to define your own schemas, along with some nice helpers for common cases.

Use cases

  • API clients

  • ORMs

  • Forms

Example model definition

from contracts.core import Contract, BaseField

# Use BaseField to define your field types, eg. StringField and
# IntegerField.

class MyModel(BaseObject):
    first_name = StringField()
    last_name = StringField()
    age = IntegerField()

Then, create some library to make use of the schema somehow 😊.

Release history Release notifications | RSS feed

This release

0.1a0 This release

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page