Repository files navigation

Odin provides a declarative framework for defining resources (classes) and their relationships, validation of the fieldsthat 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.

Docs/Help
Build
Quality
Package

• Class based declarative style
• Class based annotations style! ✨ new in 2.0
• Fields for building composite resources
• Field and Resource level validation
• Easy extension to support custom fields
• Python 3.8+ and PyPy¹ supported
• Support for documenting resources withSphinx
• Minimal dependencies

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

• Design, document and validate complex (and simple!) data structures
• Convert structures to and from different formats such as JSON, YAML, MsgPack, CSV, TOML
• Validate API inputs
• Define message formats for communications protocols, like an RPC
• Map API requests to ORM objects

• Documentation
• Project home
• Issue tracker

• XML Codec (export only)
• Complete documentation coverage
• Improvements for CSV Codec (writing, reading multi resource CSV's)

• 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
• pyyaml - To enable use of the YAML codec
• toml - To enable use of the TOML codec

• arrow - Support for Arrow data types.
• pint - Support for physical quantities using thePint library.

• pytest - Testing
• pytest-cov - Coverage reporting

importodinclassAuthor(odin.Resource):name=odin.StringField()classPublisher(odin.Resource):name=odin.StringField()classBook(odin.Resource):title=odin.StringField()authors=odin.ArrayOf(Author)publisher=odin.DictAs(Publisher)genre=odin.StringField()num_pages=odin.IntegerField()

importodinclassAuthor(odin.AnnotatedResource):name:strclassPublisher(odin.AnnotatedResource):name:strwebsite:odin.Url|NoneclassBook(odin.AnnotatedResource):title:strauthors:list[Author]publisher:Publishergenre:strnum_pages:int

>>> 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.codecsimport 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"}