{
    "info": {
        "author": "Ian Clark",
        "author_email": "ianclark001@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Environment :: Web Environment",
            "Framework :: Django",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Topic :: Internet :: WWW/HTTP"
        ],
        "description": "# Django REST framework serializer extensions\n**A collection of useful tools to DRY up your Django Rest Framework serializers**\n\nFull documentation: http://django-rest-framework-serializer-extensions.readthedocs.io/\n\n[![build-status-image]][travis]\n[![coverage-status-image]][codecov]\n[![pypi-version]][pypi]\n\n\n## Overview\nSerializer extensions reduces the need for *very similar* serializers, by\nallowing the fields to be defined on a *per-view/request* basis. Fields can be\nwhitelisted, blacklisted, and child serializers can be optionally expanded.\nWhatever fields you choose to use, your querysets can be *optimized\nautomatically* to make the fewest database calls possible.\n\nSupport for [HashIds](https://github.com/davidaurelio/hashids-python) is\nalso provided. If you're currently exposing your internal IDs over a public\nAPI, we suggest you consider switching to HashIds instead.\n\n**:star: Lovingly open-sourced by [Housekeep](https://housekeep.com).**\n\n## Requirements\nTested against:\n\n* Python (2.7, 3.6, 3.7)\n* [Django](https://github.com/django/django) (1.11, 2.1, 2.2)\n* [Django REST Framework](https://github.com/tomchristie/django-rest-framework) (3.7, 3.8, 3.9)\n* [HashIds](https://github.com/davidaurelio/hashids-python) (>1.0)\n\n\n## Installation\nInstall using `pip`:\n\n```bash\n$ pip install djangorestframework-serializer-extensions\n```\n\nAnd add `rest_framework_serializer_extensions` to your `INSTALLED_APPS` setting:\n\n```py\nINSTALLED_APPS = (\n    ...\n    'rest_framework_serializer_extensions'\n)\n```\n\n\n## Basic Usage\nTo activate the serializer extensions, add the `SerializerExtensionsMixin` to your serializers:\n\n```py\n# serializers.py\nfrom rest_framework.serializers import ModelSerializer\nfrom rest_framework_serializer_extensions.serializers import SerializerExtensionsMixin\n\n...\n\nclass OwnerSerializer(SerializerExtensionsMixin, ModelSerializer):\n    class Meta:\n        model = models.Owner\n        fields = ('id', 'name')\n        expandable_fields = dict(\n            organization=OrganizationSerializer,\n            cars=dict(\n                serializer=SkuSerializer,\n                many=True\n            )\n        )\n```\n\nAnd add the `SerializerExtensionsAPIViewMixin` to your API views:\n\n```py\nfrom rest_framework.generics import RetrieveAPIView\nfrom rest_framework_serializer_extensions.views import SerializerExtensionsAPIViewMixin\n\nclass RetriveOwnerAPIView(SerializerExtensionsAPIViewMixin, RetrieveAPIView):\n    ...\n```\n\n\n## Examples\nSerializer extensions allows your API to re-use your serializers to fit a\nvariety of use cases. The examples shown below use query parameters to\nmodify the response, but individual views can interact with your serializers\nin much the same way.\n\n```js\n>>> GET /owner/x4F/\n{\n  \"id\": 'x4F',\n  \"name\": 'tyrell',\n  \"organization_id\": 'kgD'\n}\n```\n\n```js\n>>> GET /owner/x4F/?expand=organization\n{\n  \"id\": 'x4F',\n  \"name\": 'tyrell',\n  \"organization_id\": 'kgD',\n  \"organization\": {\n    \"id\": \"kgD\",\n    \"name\": \"E Corp\"\n  }\n}\n```\n\n```js\n>>> GET /owner/x4F/?expand=cars__model&exclude=name\n{\n  \"id\": 'x4F',\n  \"organization_id\": 'kgD',\n  \"cars\": [\n    {\n      \"id\": \"wf9\",\n      \"variant\": \"P100D\",\n      \"model\": {\n        \"id\": \"ncX\",\n        \"name\": \"Model S\"\n      }\n    }\n  ]\n}\n```\n\n```js\n>>> GET /owner/x4F/?expand=cars&only=cars__variant\n{\n  \"cars\": [\n    {\n      \"variant\": \"P100D\",\n    }\n  ]\n}\n```\n\n\n## Testing\nInstall testing requirements.\n\n```bash\n$ pip install -r requirements.txt\n```\n\nRun with runtests.\n\n```bash\n$ ./runtests.py\n```\n\nYou can also use the excellent\n[tox](http://tox.readthedocs.org/en/latest/) testing tool to run the\ntests against all supported versions of Python and Django. Install tox\nglobally, and then simply run:\n\n```bash\n$ tox\n```\n\n\n## Documentation\nTo build the documentation, you\u2019ll need to install `mkdocs`.\n\n```bash\n$ pip install mkdocs\n```\n\nTo preview the documentation:\n\n```bash\n$ mkdocs serve\nRunning at: http://127.0.0.1:8000/\n```\n\nTo build the documentation:\n\n```bash\n$ mkdocs build\n```\n\n\n[build-status-image]: https://secure.travis-ci.org/evenicoulddoit/django-rest-framework-serializer-extensions.svg?branch=master\n[travis]: https://secure.travis-ci.org/evenicoulddoit/django-rest-framework-serializer-extensions?branch=master\n[coverage-status-image]: https://img.shields.io/codecov/c/github/evenicoulddoit/django-rest-framework-serializer-extensions/master.svg\n[codecov]: http://codecov.io/github/evenicoulddoit/django-rest-framework-serializer-extensions?branch=master\n[pypi-version]: https://img.shields.io/pypi/v/djangorestframework-serializer-extensions.svg\n[pypi]: https://pypi.python.org/pypi/djangorestframework-serializer-extensions\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": "https://pythonhosted.org/djangorestframework-serializer-extensions/",
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/evenicoulddoit/django-rest-framework-serializer-extensions",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "djangorestframework-serializer-extensions",
        "package_url": "https://pypi.org/project/djangorestframework-serializer-extensions/",
        "platform": "",
        "project_url": "https://pypi.org/project/djangorestframework-serializer-extensions/",
        "project_urls": {
            "Homepage": "https://github.com/evenicoulddoit/django-rest-framework-serializer-extensions"
        },
        "release_url": "https://pypi.org/project/djangorestframework-serializer-extensions/1.0.0/",
        "requires_dist": [
            "hashids (>1.0.0)"
        ],
        "requires_python": "",
        "summary": "Extensions to DRY up Django Rest Framework serializers",
        "version": "1.0.0"
    },
    "last_serial": 5169505,
    "releases": {
        "0.1.0": [],
        "0.2.0": [],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8921fc7b60625a84c3ff1fa3e4e21734",
                    "sha256": "7987c3740e98a0e02b6eb76408173645f748399ebe8ba8ee9a25de1014be6603"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8921fc7b60625a84c3ff1fa3e4e21734",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9144,
                "upload_time": "2016-12-22T17:02:55",
                "url": "https://files.pythonhosted.org/packages/dd/2d/4eb351208aa4590d767b68ed86c505a2cc031d88c3ee7429b7f41f2d8bae/djangorestframework-serializer-extensions-0.3.0.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0faf0b54766447a99b56e2fc24692a92",
                    "sha256": "e06fcce2e85792bea2bd04068109baf17b732112bd0e8a9595da59ece43a5ffe"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "0faf0b54766447a99b56e2fc24692a92",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11277,
                "upload_time": "2016-12-24T15:17:19",
                "url": "https://files.pythonhosted.org/packages/5c/d0/fd6e4d4afdf25b68bb3167170cfd7f2b18144929d383134ca559f069a2b6/djangorestframework-serializer-extensions-0.4.0.tar.gz"
            }
        ],
        "0.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "305dc9ef738dc69e9ee4c9c425b9bf87",
                    "sha256": "91a498aaf26959042b36dad49f1a76a2aab26bb7e757fb3bfbae17e6fa89d62f"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.5.0.tar.gz",
                "has_sig": false,
                "md5_digest": "305dc9ef738dc69e9ee4c9c425b9bf87",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12825,
                "upload_time": "2017-01-20T16:53:04",
                "url": "https://files.pythonhosted.org/packages/f5/1a/5797f1d237e3b9ef93228e3b50984dd819cb5a8017b48d43d5d6397a9cf1/djangorestframework-serializer-extensions-0.5.0.tar.gz"
            }
        ],
        "0.5.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c74ae934f31fe7b1b1b397f9c5977dc4",
                    "sha256": "3b9d49d5d1439b09b7497fd55275d1fb949ac4f8022dff8820c9fe446a4fafff"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.5.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c74ae934f31fe7b1b1b397f9c5977dc4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12856,
                "upload_time": "2017-04-11T15:04:24",
                "url": "https://files.pythonhosted.org/packages/70/33/090793807df76808f38d6925a4c21354ee971f51262746533162766028fc/djangorestframework-serializer-extensions-0.5.1.tar.gz"
            }
        ],
        "0.5.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "18ffac4166d7974c75aa232cf8fa385e",
                    "sha256": "d818a8380ae2d301f317404f04dd7bf57cef9c40afb31c75a1845bce05565a8e"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.5.2.tar.gz",
                "has_sig": false,
                "md5_digest": "18ffac4166d7974c75aa232cf8fa385e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12777,
                "upload_time": "2017-06-19T11:05:22",
                "url": "https://files.pythonhosted.org/packages/9f/ed/824b8dcae3ad515b76fad7d424527fa9b3bb72f1bcdce180e7358d5ac4af/djangorestframework-serializer-extensions-0.5.2.tar.gz"
            }
        ],
        "0.5.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "79e7eb99a774fbb1e617a21a6d3c588b",
                    "sha256": "27429069e05143e64523bdab6f8ae8956ac73be80e934e9de680b1992da9923d"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.5.3.tar.gz",
                "has_sig": false,
                "md5_digest": "79e7eb99a774fbb1e617a21a6d3c588b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12819,
                "upload_time": "2017-09-17T07:11:11",
                "url": "https://files.pythonhosted.org/packages/73/53/b4a804ecf64afbe490818315317548fef83c0a2bed66d9530c2552fc6ab4/djangorestframework-serializer-extensions-0.5.3.tar.gz"
            }
        ],
        "0.5.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "89dfcc489891777c88dbed0324ec7412",
                    "sha256": "1bad2dfb56f7052668f64196414c4723da3cdf6481ac793b399d809688d9d687"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.5.4.tar.gz",
                "has_sig": false,
                "md5_digest": "89dfcc489891777c88dbed0324ec7412",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13112,
                "upload_time": "2017-12-23T19:17:07",
                "url": "https://files.pythonhosted.org/packages/38/9d/3852e240403d1a56352a2149308284be51202e9376ff3358393f8b51423a/djangorestframework-serializer-extensions-0.5.4.tar.gz"
            }
        ],
        "0.6.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "14c16cb2439ec77beea9590464a48dd3",
                    "sha256": "93075fd203a2834c62f3e24a126b7d6b864db39ce7e8d302d27aeafffb8c89cc"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-0.6.0.tar.gz",
                "has_sig": false,
                "md5_digest": "14c16cb2439ec77beea9590464a48dd3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14994,
                "upload_time": "2018-07-02T18:50:45",
                "url": "https://files.pythonhosted.org/packages/69/ea/9b6ffb8ff128f510c0927715972ffc78a151e459d2008c3b006f28c8381e/djangorestframework-serializer-extensions-0.6.0.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "158bd6063e97220ac0cf82d4c3eed428",
                    "sha256": "c383f18bf38ee1277cc8cb738f4667b8b9b6bd9a2f98ca938f8ac8c703a68ae4"
                },
                "downloads": -1,
                "filename": "djangorestframework_serializer_extensions-1.0.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "158bd6063e97220ac0cf82d4c3eed428",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 15957,
                "upload_time": "2019-04-21T10:05:37",
                "url": "https://files.pythonhosted.org/packages/b3/c1/7ee41dd8f128a42becb522a2c14b103de59f75d015bb58603086e4e3bd68/djangorestframework_serializer_extensions-1.0.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f258e6ab8bd59155316c00ed1afda0e3",
                    "sha256": "f44c5592dfd1289af1bd6afb6ba9b2afe0881c5cd9c242e8e76f08a9fcab16cb"
                },
                "downloads": -1,
                "filename": "djangorestframework-serializer-extensions-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f258e6ab8bd59155316c00ed1afda0e3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14947,
                "upload_time": "2019-04-21T10:05:38",
                "url": "https://files.pythonhosted.org/packages/6d/25/4015fe36fbe41b0b5e5923914b5daf7e61eb07f916f72a70ebc2955dfef2/djangorestframework-serializer-extensions-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "158bd6063e97220ac0cf82d4c3eed428",
                "sha256": "c383f18bf38ee1277cc8cb738f4667b8b9b6bd9a2f98ca938f8ac8c703a68ae4"
            },
            "downloads": -1,
            "filename": "djangorestframework_serializer_extensions-1.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "158bd6063e97220ac0cf82d4c3eed428",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 15957,
            "upload_time": "2019-04-21T10:05:37",
            "url": "https://files.pythonhosted.org/packages/b3/c1/7ee41dd8f128a42becb522a2c14b103de59f75d015bb58603086e4e3bd68/djangorestframework_serializer_extensions-1.0.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f258e6ab8bd59155316c00ed1afda0e3",
                "sha256": "f44c5592dfd1289af1bd6afb6ba9b2afe0881c5cd9c242e8e76f08a9fcab16cb"
            },
            "downloads": -1,
            "filename": "djangorestframework-serializer-extensions-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f258e6ab8bd59155316c00ed1afda0e3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14947,
            "upload_time": "2019-04-21T10:05:38",
            "url": "https://files.pythonhosted.org/packages/6d/25/4015fe36fbe41b0b5e5923914b5daf7e61eb07f916f72a70ebc2955dfef2/djangorestframework-serializer-extensions-1.0.0.tar.gz"
        }
    ]
}