{ "info": { "author": "Jerel Unruh", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "==================================\nJSON API and Django Rest Framework\n==================================\n\n.. image:: https://travis-ci.org/django-json-api/django-rest-framework-json-api.svg?branch=develop\n :target: https://travis-ci.org/django-json-api/django-rest-framework-json-api\n\n.. image:: https://readthedocs.org/projects/django-rest-framework-json-api/badge/?version=latest\n :alt: Read the docs\n :target: http://django-rest-framework-json-api.readthedocs.org/\n\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n :alt: Join the chat at https://gitter.im/django-json-api/django-rest-framework-json-api\n :target: https://gitter.im/django-json-api/django-rest-framework-json-api\n\n--------\nOverview\n--------\n\n**JSON API support for Django REST Framework**\n\n* Documentation: http://django-rest-framework-json-api.readthedocs.org/\n* Format specification: http://jsonapi.org/format/\n\n\nBy default, Django REST Framework will produce a response like::\n\n {\n \"count\": 20,\n \"next\": \"http://example.com/api/1.0/identities/?page=3\",\n \"previous\": \"http://example.com/api/1.0/identities/?page=1\",\n \"results\": [{\n \"id\": 3,\n \"username\": \"john\",\n \"full_name\": \"John Coltrane\"\n }]\n }\n\n\nHowever, for an ``identity`` model in JSON API format the response should look\nlike the following::\n\n {\n \"links\": {\n \"prev\": \"http://example.com/api/1.0/identities\",\n \"self\": \"http://example.com/api/1.0/identities?page=2\",\n \"next\": \"http://example.com/api/1.0/identities?page=3\",\n },\n \"data\": [{\n \"type\": \"identities\",\n \"id\": 3,\n \"attributes\": {\n \"username\": \"john\",\n \"full-name\": \"John Coltrane\"\n }\n }],\n \"meta\": {\n \"pagination\": {\n \"count\": 20\n }\n }\n }\n\n\n------------\nRequirements\n------------\n\n1. Python (2.7, 3.4, 3.5, 3.6)\n2. Django (1.11, 2.0)\n3. Django REST Framework (3.6, 3.7)\n\n------------\nInstallation\n------------\n\nFrom PyPI\n^^^^^^^^^\n\n::\n\n $ pip install djangorestframework-jsonapi\n\n\nFrom Source\n^^^^^^^^^^^\n\n::\n\n $ git clone https://github.com/django-json-api/django-rest-framework-json-api.git\n $ cd django-rest-framework-json-api\n $ pip install -e .\n\n\nRunning the example app\n^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n $ git clone https://github.com/django-json-api/django-rest-framework-json-api.git\n $ cd django-rest-framework-json-api\n $ pip install -e .\n $ django-admin.py runserver --settings=example.settings\n\nBrowse to http://localhost:8000\n\n\nRunning Tests\n^^^^^^^^^^^^^\n\nIt is recommended to create a virtualenv for testing. Assuming it is already\ninstalled and activated:\n\n::\n\n $ pip install -e .\n $ pip install -r requirements-development.txt\n $ py.test\n\n\n-----\nUsage\n-----\n\n\n``rest_framework_json_api`` assumes you are using class-based views in Django\nRest Framework.\n\n\nSettings\n^^^^^^^^\n\nOne can either add ``rest_framework_json_api.parsers.JSONParser`` and\n``rest_framework_json_api.renderers.JSONRenderer`` to each ``ViewSet`` class, or\noverride ``settings.REST_FRAMEWORK``\n\n::\n\n REST_FRAMEWORK = {\n 'PAGE_SIZE': 10,\n 'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler',\n 'DEFAULT_PAGINATION_CLASS':\n 'rest_framework_json_api.pagination.PageNumberPagination',\n 'DEFAULT_PARSER_CLASSES': (\n 'rest_framework_json_api.parsers.JSONParser',\n 'rest_framework.parsers.FormParser',\n 'rest_framework.parsers.MultiPartParser'\n ),\n 'DEFAULT_RENDERER_CLASSES': (\n 'rest_framework_json_api.renderers.JSONRenderer',\n 'rest_framework.renderers.BrowsableAPIRenderer',\n ),\n 'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',\n }\n\nIf ``PAGINATE_BY`` is set the renderer will return a ``meta`` object with\nrecord count and a ``links`` object with the next and previous links. Pages\ncan be specified with the ``page`` GET parameter.\n\nThis package provides much more including automatic inflection of JSON keys, extra top level data (using nested serializers), relationships, links, and handy shortcuts like MultipleIDMixin. Read more at http://django-rest-framework-json-api.readthedocs.org/", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/django-json-api/django-rest-framework-json-api", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "ak-djangorestframework-jsonapi", "package_url": "https://pypi.org/project/ak-djangorestframework-jsonapi/", "platform": "", "project_url": "https://pypi.org/project/ak-djangorestframework-jsonapi/", "project_urls": { "Homepage": "https://github.com/django-json-api/django-rest-framework-json-api" }, "release_url": "https://pypi.org/project/ak-djangorestframework-jsonapi/2.4.0.post0/", "requires_dist": null, "requires_python": "", "summary": "A Django REST framework API adapter for the JSON API spec.", "version": "2.4.0.post0" }, "last_serial": 3673452, "releases": { "2.2.0": [ { "comment_text": "", "digests": { "md5": "ce8f5cc7fc778e5956c4b00f82bbebaa", "sha256": "5e38264c57eb98473bf1e96136e6ad32ce6279e5122769c810d16f6ea6a5c23c" }, "downloads": -1, "filename": "ak-djangorestframework-jsonapi-2.2.0.tar.gz", "has_sig": false, "md5_digest": "ce8f5cc7fc778e5956c4b00f82bbebaa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 47305, "upload_time": "2017-10-25T16:16:07", "url": "https://files.pythonhosted.org/packages/0e/80/2637bdf352716311507319420b90e417447342da8fd83d9a94d19829f74c/ak-djangorestframework-jsonapi-2.2.0.tar.gz" } ], "2.4.0.post0": [ { "comment_text": "", "digests": { "md5": "43f7d6399c9753c7eedd4970fdeecda2", "sha256": "de2beb916f3506bee5b5c2330b2fd821838a0b8eeb2cfeb2ca087a54ad551961" }, "downloads": -1, "filename": "ak-djangorestframework-jsonapi-2.4.0.post0.tar.gz", "has_sig": false, "md5_digest": "43f7d6399c9753c7eedd4970fdeecda2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 49779, "upload_time": "2018-03-15T17:37:07", "url": "https://files.pythonhosted.org/packages/5f/63/fdafc59e435cf426ac5a95711e8385b1f466ac20f17f46b0b9537570995f/ak-djangorestframework-jsonapi-2.4.0.post0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "43f7d6399c9753c7eedd4970fdeecda2", "sha256": "de2beb916f3506bee5b5c2330b2fd821838a0b8eeb2cfeb2ca087a54ad551961" }, "downloads": -1, "filename": "ak-djangorestframework-jsonapi-2.4.0.post0.tar.gz", "has_sig": false, "md5_digest": "43f7d6399c9753c7eedd4970fdeecda2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 49779, "upload_time": "2018-03-15T17:37:07", "url": "https://files.pythonhosted.org/packages/5f/63/fdafc59e435cf426ac5a95711e8385b1f466ac20f17f46b0b9537570995f/ak-djangorestframework-jsonapi-2.4.0.post0.tar.gz" } ] }