https://github.com/mikeywaites/kim

Kim: A JSON Serialization and Marshaling framework
https://github.com/mikeywaites/kim

json marshalling python rest-api serialization

Last synced: 3 months ago
JSON representation

Kim: A JSON Serialization and Marshaling framework

• Host: GitHub
• URL: https://github.com/mikeywaites/kim
• Owner: mikeywaites
• License: other
• Created: 2014-01-29T14:45:21.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-02-16T16:13:53.000Z (over 4 years ago)
• Last Synced: 2024-07-10T20:43:01.872Z (4 months ago)
• Topics: json, marshalling, python, rest-api, serialization
• Language: Python
• Homepage: http://kim.readthedocs.org/en/latest/
• Size: 808 KB
• Stars: 317
• Watchers: 10
• Forks: 17
• Open Issues: 16
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-python-models - kim - A JSON Serialization and Marshaling framework. (Model, Schema)
• awesome-discoveries - Kim - a JSON Serialization and Marshaling framework _(`Python`)_ (Libraries)
• starred-awesome - kim - Kim: A JSON Serialization and Marshaling framework (Python)

README

        
Kim: A JSON Serialization and Marshaling framework

===================================================

.. image:: https://img.shields.io/pypi/v/py-kim.svg

    :target: https://pypi.python.org/pypi/py-kim

.. image:: https://img.shields.io/pypi/l/py-kim.svg

    :target: https://pypi.python.org/pypi/py-kim

.. image:: https://circleci.com/gh/mikeywaites/kim.svg?style=shield&circle-token=d46954b5e66c2cc885f35c745baaea9a70e961af

    :target: https://pypi.python.org/pypi/py-kim

**Introducing Kim**::

.. code-block:: python

    >>> mapper = UserMapper(data=response.json())

    >>> mapper.marshal()

    User(id='one', name='Bruce Wayne', 'title'='CEO/Super Hero')

    >>> user_two = User.query.get('two')

    >>> mapper = UserMapper(obj=user_two)

    >>> mapper.serialize()

    {u'id': 'two', u'name': 'Martha Wayne', 'title': 'Mother of Batman'}

Kim Features

------------

Kim is a feature packed framework for handling even the most complex

marshaling and serialization requirements.

- Web framework agnostic - Flask, Django, Framework-XXX supported!

- Highly customisable field processing system

- Security focused

- Control included fields with powerful roles system

- Handle mixed data types with polymorphic mappers

- Marshal and Serialize nested objects

Kim officially supports Python 2.7 & 3.3–3.5

Installation

------------

Install Kim using pip::

.. code-block:: bash

    $ pip install py-kim

Documentation

-------------

Learn all of Kim's features with these simple step-by-step instructions or check out the

quickstart guide for a rapid overview to get going quickly.

http://kim.readthedocs.io/en/latest/