Skip to main content

Object Data Mapping for Python

Project description

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.

License https://pypip.in/v/odin/badge.png Travis CI Status Coveralls Requirements Status Gitter.im

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 1 supported

  • Integration with Django (see baldr)

  • Minimal dependencies (base functionality only requires six)

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

Upcoming features

In development

  • Customisable generation of documentation of resources (for integration into Sphinx)

  • 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

  • six

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, pretty_print=True)
{
    "$": "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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odin-0.5.6.tar.gz (55.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page