Skip to main content

Django Rest Framework tools which are compliant with the JSONAPI 1.0 specification

Project description

build-status-image pypi-version read-the-docs

Overview

Django Rest Framework tools which are compliant with the JSONAPI 1.0 specification.

Documentation: django-rest-framework-jsonapi.rtfd.org

Requirements

  • Python (2.7, 3.4)

  • Django (1.6, 1.7, 1.8)

  • Django REST Framework (3.1)

Installation

Install using pip

$ pip install drf-jsonapi

Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

$ tox

Documentation

The documentation is browsable on Read the Docs: django-rest-framework-jsonapi.rtfd.org

To build the documentation, you’ll need to install mkdocs.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

$ mkdocs build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

drf-jsonapi-0.1.6.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

drf_jsonapi-0.1.6-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file drf-jsonapi-0.1.6.tar.gz.

File metadata

  • Download URL: drf-jsonapi-0.1.6.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for drf-jsonapi-0.1.6.tar.gz
Algorithm Hash digest
SHA256 26f63a366d865b3a3a1a2420ef031d5a59a3d25152e9f4be5c23d15c3303ca66
MD5 5a9679dc68949c095d9afb4059a97b3d
BLAKE2b-256 caea5705289327ac3b14b90d6a7543ab904a7275938dc8465b37a8cb01dd49a6

See more details on using hashes here.

File details

Details for the file drf_jsonapi-0.1.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for drf_jsonapi-0.1.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5dcf25efb119306a4aabf755763f7f1b6e369e595599d8b732a559ec5aee8fee
MD5 b4c863ed4990f19c1d3ede67739a7f90
BLAKE2b-256 d1de45a29f72e3983f3348a815ae9eedbb15a705df04a48caa03f1b25eeff87d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page