Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

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.

Release files for drf-ember 0.1.0b3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for drf-ember 0.1.0b3
File Size Uploaded
drf-ember-0.1.0b3.tar.gz 20.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for drf-ember 0.1.0b3
File Interpreter ABI Platform
drf_ember-0.1.0b3-py3-none-any.whl Python 3 none any Details

Total release size: 46.1 kB

Release files / drf-ember-0.1.0b3.tar.gz

Download URL drf-ember-0.1.0b3.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
93fb49834d803960d0fab6d8574a215fed86e9f38f09dc97d1950a432570168b
BLAKE2b-256 checksum
How to use checksums
c1e07bf2369e3ebf2b669ca55e2e56731b366cccdcbea390e8f5926c710b7840
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / drf_ember-0.1.0b3-py3-none-any.whl

Download URL drf_ember-0.1.0b3-py3-none-any.whl
Size 26.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
49386b8a2aeba4c1ad59f5c12d43749bb2ee19885b6c9afb0fe031142cce2fcd
BLAKE2b-256 checksum
How to use checksums
89382e1529febf19ddde846d8890b73115c418c8eaca2e87fae9488f6394cc1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0b3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page