Metadata-Version: 2.0
Name: drf-ember
Version: 0.1.0b2
Summary: Enables Django REST Framework support for Ember Data's JSON API implementation.
Home-page: https://github.com/symfonico/drf-ember
Author: Julio Gonzalez Altamirano
Author-email: devjga@gmail.com
License: MIT
Keywords: ember django rest json-api framework
Platform: Any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Dist: django
Requires-Dist: djangorestframework
Requires-Dist: inflection

=========
drf-ember
=========

Enables Django REST Framework support for Ember Data's JSON API implementation.

JSON API feature support
------------------------

Presently, **drf-ember** supports a majority - but not all - of
the JSON API specifications features and extensions.

Supported
.........

These features are supported.

- Generation of JSON API document structure

- The core functionality for retrieval, creation, updating, and deletion of resources

- The ``included`` top-level member is supported by parsing nested serializer fields.
  See the *Getting Started* guide in the documentation.

- Error objects

- The bulk extension for creation and updating of resource lists

Not supported
.............

These features are not supported.

- ``links`` objects are not generated

- Fetching relationship data for every relationship URL provided as a ``self``
  link as part of a relationship's ``links`` object.

- Endpoints can't presently support an ``include`` request parameter which
  allows the client to customize which related resources should be returned.
  Presently, **drf-ember** will return a blank ``400`` if the ``include``
  request parameter is present.

- Sparse fieldsets

- Sort fields through query parameters

- Updating relationships at URLs from relationship links

Requirements
------------

Python 3. Python 2 is **not** supported and there is **no** plan to support it.

Install
-------

Use ``pip``::

    pip install drf-ember

Documentation
-------------

You can read the documentation on the **drf-ember**
`Read The Docs page <http://drf-ember.readthedocs.org/en/latest/>`_.

Contributing
------------

The Github repository is the issue tracker. Please submit issues here. Pull requests are appreciated.

Please follow the Django Community Code of Conduct (https://www.djangoproject.com/conduct/) while
contributing to **drf-ember**.

Tests
-----

Use **py.test**. Make sure you have it installed. Clone the **drf-ember** repository.
>From the repository directory, run::

    py.test tests

Releases
--------

Please check the project's CHANGELOG.md file for detailed changes.

