odin · PyPI

Odin provides a declarative framework for defining resources (classes) and their relationships, validation of the fields that make up the resources and mapping between objects (either a resource, or other python structures).

Odin also comes with built in serialisation tools for importing and exporting data from resources.

https://img.shields.io/pypi/v/odin.svg?style=flat

Highlights

Class based declarative style
Fields for building composite resources
Field and Resource level validation
Mapping between resources or extended to other object types (eg Django Models)
Easy extension to support custom fields
Python 2.7+, Python 3.3+ and PyPy ¹ supported
Integration with Django (see baldr)
Support for documenting resources with Sphinx
Minimal dependencies (base functionality only requires six)

¹ certain contrib items are not supported. Pint is not installable with PyPy.

Quick links

Upcoming features

In development

XML Codec (export completed)
Complete documentation, this will pretty much always be here.
Improvements for CSV Codec (writing, reading multi resource CSV’s)
RESTful interface with support for Flask and Django see (see baldr)
Integration with other libraries (ie Django Models/Forms) (see baldr)

Planning

YAML codec

Requires

Optional

simplejson - Odin will use simplejson if it is available or fallback to the builtin json library
msgpack-python - To enable use of the msgpack codec

Contrib

jinja2 >= 2.7 - For documentation generation
pint - Support for physical quantities using the Pint library.

Example

With definition:

import odin

class Author(odin.Resource):
    name = odin.StringField()

class Publisher(odin.Resource):
    name = odin.StringField()

class Book(odin.Resource):
    title = odin.StringField()
    authors = odin.ArrayOf(Author)
    publisher = odin.DictAs(Publisher)
    genre = odin.StringField()
    num_pages = odin.IntegerField()

>>> b = Book(
        title="Consider Phlebas",
        genre="Space Opera",
        publisher=Publisher(name="Macmillan"),
        num_pages=471
    )
>>> b.authors.append(Author(name="Iain M. Banks"))
>>> from odin.codecs import json_codec
>>> json_codec.dumps(b, indent=4)
{
    "$": "Book",
    "authors": [
        {
            "$": "Author",
            "name": "Iain M. Banks"
        }
    ],
    "genre": "Space Opera",
    "num_pages": 471,
    "publisher": {
        "$": "Publisher",
        "name": "Macmillan"
    },
    "title": "Consider Phlebas"
}

Authors

Tim Savage

Special Mention

I would like to acknowledge the strong influence on the design of Odin from the Django ORM and it’s notable contributor Malcolm Tredinnick. He was a valued colleague who’s untimely passing left a large void in our company and the wider community.

Release files for odin 0.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odin 0.7.1
File	Size	Uploaded
odin-0.7.1.tar.gz	66.6 kB	Mar 7, 2016	Details

Release files / odin-0.7.1.tar.gz

Download URL	odin-0.7.1.tar.gz
Size	66.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`247e106691cfab9e57d6497877c17d851682e8ee139a486766fe3fad1507455c`
BLAKE2b-256 checksum How to use checksums	`8ea24736ab96bda6603663ccd12db7b26942c0f4b440937fc43f79c3659e68cd`
Upload date	Mar 7, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No