<commit_before>
####
Odin
####

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.

.. image:: https://img.shields.io/pypi/l/odin.svg?style=flat
    :target: https://pypi.python.org/pypi/odin/
    :alt: License

.. image:: https://img.shields.io/pypi/v/odin.svg?style=flat
    :target: https://pypi.python.org/pypi/odin/

.. image:: https://img.shields.io/travis/python-odin/odin.svg?style=flat
    :target: https://travis-ci.org/python-odin/odin
    :alt: Travis CI Status

.. image:: https://img.shields.io/coveralls/python-odin/odin.svg?style=flat
    :target: https://coveralls.io/github/python-odin/odin
    :alt: Coveralls

.. image:: https://img.shields.io/requires/github/timsavage/odin.svg?style=flat
    :target: https://requires.io/github/timsavage/odin/requirements/?branch=master
    :alt: Requirements Status

.. image:: https://img.shields.io/badge/gitterim-timsavage.odin-brightgreen.svg?style=flat
    :target: https://gitter.im/timsavage/odin
    :alt: 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 :sup:`1` supported
* Integration with Django (see `baldr <https://github.com/timsavage/baldr>`_)
* Support for documenting resources with `Sphinx <http://sphinx-doc.org/>`_
* Minimal dependencies (base functionality only requires *six*)

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


Quick links
***********

* `Documentation <https://odin.readthedocs.org/>`_
* `Project home <https://github.com/python-odin/odin>`_
* `Issue tracker <https://github.com/python-odin/odin/issues>`_


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
* Integration with other libraries (ie `Django <https://www.djangoproject.com/>`_ Models/Forms)

**Planning**

* YAML codec

<commit_msg>Correct reference to baldr<commit_after>
####
Odin
####

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.

.. image:: https://img.shields.io/pypi/l/odin.svg?style=flat
    :target: https://pypi.python.org/pypi/odin/
    :alt: License

.. image:: https://img.shields.io/pypi/v/odin.svg?style=flat
    :target: https://pypi.python.org/pypi/odin/

.. image:: https://img.shields.io/travis/python-odin/odin.svg?style=flat
    :target: https://travis-ci.org/python-odin/odin
    :alt: Travis CI Status

.. image:: https://img.shields.io/coveralls/python-odin/odin.svg?style=flat
    :target: https://coveralls.io/github/python-odin/odin
    :alt: Coveralls

.. image:: https://img.shields.io/requires/github/timsavage/odin.svg?style=flat
    :target: https://requires.io/github/timsavage/odin/requirements/?branch=master
    :alt: Requirements Status

.. image:: https://img.shields.io/badge/gitterim-timsavage.odin-brightgreen.svg?style=flat
    :target: https://gitter.im/timsavage/odin
    :alt: 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 :sup:`1` supported
* Integration with Django (see `baldr <https://github.com/python-odin/baldr>`_)
* Support for documenting resources with `Sphinx <http://sphinx-doc.org/>`_
* Minimal dependencies (base functionality only requires *six*)

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


Quick links
***********

* `Documentation <https://odin.readthedocs.org/>`_
* `Project home <https://github.com/python-odin/odin>`_
* `Issue tracker <https://github.com/python-odin/odin/issues>`_


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
* Integration with other libraries (ie `Django <https://www.djangoproject.com/>`_ Models/Forms)

**Planning**

* YAML codec


{'fraction_non_alphanumeric': 0.13941825476429287, 'fraction_numerical': 0.002407221664994985, 'mean_word_length': 4.425462459194777, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 34, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1612864', 'n_tokens_mistral': 1654, 'n_tokens_neox': 1538, 'n_words': 433}