{
    "info": {
        "author": "Danilo Bargen",
        "author_email": "mail@dbrgn.ch",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Web Environment",
            "Framework :: Django",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 3"
        ],
        "description": "Dynamic Serializer Fields for Django REST Framework\n===================================================\n\n.. image:: https://secure.travis-ci.org/dbrgn/drf-dynamic-fields.png?branch=master\n    :alt: Build status\n    :target: http://travis-ci.org/dbrgn/drf-dynamic-fields\n\n.. image:: https://img.shields.io/pypi/v/drf-dynamic-fields.svg\n    :alt: PyPI Version\n    :target: https://pypi.python.org/pypi/drf-dynamic-fields\n\n.. image:: https://img.shields.io/pypi/dm/drf-dynamic-fields.svg?maxAge=3600\n    :alt: PyPI Downloads\n    :target: https://pypi.python.org/pypi/drf-dynamic-fields\n\n.. image:: https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000\n    :alt: License is MIT\n    :target: https://github.com/dbrgn/drf-dynamic-fields/blob/master/LICENSE\n\nThis package provides a mixin that allows the user to dynamically select only a\nsubset of fields per resource.\n\nOfficial version support:\n\n- Django 1.11, 2.0, 2.1\n- Supported REST Framework versions: 3.8, 3.9\n- Python 2.7 (deprecated), 3.4+\n\nNOTE: Python 2 support is deprecated and will be removed in version 0.4.\n\n\nInstalling\n----------\n\n::\n\n    pip install drf-dynamic-fields\n\nWhat It Does\n------------\n\nExample serializer:\n\n.. sourcecode:: python\n\n    class IdentitySerializer(DynamicFieldsMixin, serializers.HyperlinkedModelSerializer):\n        class Meta:\n            model = models.Identity\n            fields = ('id', 'url', 'type', 'data')\n\nA regular request returns all fields:\n\n``GET /identities``\n\n.. sourcecode:: json\n\n    [\n      {\n        \"id\": 1,\n        \"url\": \"http://localhost:8000/api/identities/1/\",\n        \"type\": 5,\n        \"data\": \"John Doe\"\n      },\n      ...\n    ]\n\nA query with the `fields` parameter on the other hand returns only a subset of\nthe fields:\n\n``GET /identities/?fields=id,data``\n\n.. sourcecode:: json\n\n    [\n      {\n        \"id\": 1,\n        \"data\": \"John Doe\"\n      },\n      ...\n    ]\n\nAnd a query with the `omit` parameter excludes specified fields.\n\n``GET /identities/?omit=data``\n\n.. sourcecode:: json\n\n    [\n      {\n        \"id\": 1,\n        \"url\": \"http://localhost:8000/api/identities/1/\",\n        \"type\": 5\n      },\n      ...\n    ]\n\nYou can use both `fields` and `omit` in the same request!\n\n``GET /identities/?omit=data,fields=data,id``\n\n.. sourcecode:: json\n\n    [\n      {\n        \"id\": 1\n      },\n      ...\n    ]\n\n\nThough why you would want to do something like that is beyond this author.\n\nIt also works on single objects!\n\n``GET /identities/1/?fields=id,data``\n\n.. sourcecode:: json\n\n    {\n      \"id\": 1,\n      \"data\": \"John Doe\"\n    }\n\nUsage\n-----\n\nWhen defining a serializer, use the ``DynamicFieldsMixin``:\n\n.. sourcecode:: python\n\n    from drf_dynamic_fields import DynamicFieldsMixin\n\n    class IdentitySerializer(DynamicFieldsMixin, serializers.ModelSerializer):\n        class Meta:\n            model = models.Identity\n            fields = ('id', 'url', 'type', 'data')\n\nThe mixin needs access to the ``request`` object. Some DRF classes like the\n``ModelViewSet`` set that by default, but if you handle serializers yourself,\npass in the request through the context:\n\n.. sourcecode:: python\n\n    events = Event.objects.all()\n    serializer = EventSerializer(events, many=True, context={'request': request})\n\n\nWarnings\n--------\n\nIf the request context does not have access to the request, a warning is\nemitted::\n\n   UserWarning: Context does not have access to request.\n\nFirst, make sure that you are passing the request to the serializer context (see\n\"Usage\" section).\n\nThere are some cases (e.g. nested serializers) where you cannot get rid of the\nwarning that way (see `issue 27 <https://github.com/dbrgn/drf-dynamic-fields/issues/27>`_).\nIn that case, you can silence the warning through ``settings.py``:\n\n.. sourcecode:: python\n\n   DRF_DYNAMIC_FIELDS = {\n      'SUPPRESS_CONTEXT_WARNING': True,\n   }\n\nScope\n-----\n\nThis library is about filtering fields based on individual requests. It is\ndeliberately kept simple and we do not plan to add new features. Feel free to\ncontribute improvements, code simplifications and bugfixes though! (See also:\n`#18 <https://github.com/dbrgn/drf-dynamic-fields/issues/18>`__)\n\nIf you need more advanced filtering features, maybe `drf-flex-fields\n<https://github.com/rsinger86/drf-flex-fields>`_ could be something for you.\n\n\nTesting\n-------\n\nTo run tests, install Django and DRF and then run ``runtests.py``:\n\n    $ python runtests.py\n\n\nCredits\n-------\n\n- The implementation is based on `this\n  <http://stackoverflow.com/a/23674297/284318>`__ StackOverflow answer. Thanks\n  ``YAtOff``!\n- The GitHub users ``X17`` and ``rawbeans`` provided improvements on `my gist\n  <https://gist.github.com/dbrgn/4e6fc1fe5922598592d6>`__ that were incorporated\n  into this library. Thanks!\n- For other contributors, please see `Github contributor stats\n  <https://github.com/dbrgn/drf-dynamic-fields/graphs/contributors>`__.\n\n\nLicense\n-------\n\nMIT license, see ``LICENSE`` file.\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/dbrgn/drf-dynamic-fields",
        "keywords": "drf restframework rest_framework django_rest_framework serializers",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "drf-dynamic-fields",
        "package_url": "https://pypi.org/project/drf-dynamic-fields/",
        "platform": "",
        "project_url": "https://pypi.org/project/drf-dynamic-fields/",
        "project_urls": {
            "Homepage": "https://github.com/dbrgn/drf-dynamic-fields"
        },
        "release_url": "https://pypi.org/project/drf-dynamic-fields/0.3.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Dynamically return subset of Django REST Framework serializer fields",
        "version": "0.3.1"
    },
    "last_serial": 4885401,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3f0f8e157b9363539baea5fe642c73ad",
                    "sha256": "cd258d8e500d53ff53af70d866226dbeb29426929858e47ae89f06a575eb0041"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.1.0-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "3f0f8e157b9363539baea5fe642c73ad",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 4762,
                "upload_time": "2016-09-30T14:32:34",
                "url": "https://files.pythonhosted.org/packages/1f/13/a9562943f3dafa86556ef762a671c26750ed79afc0aa8eee8b77ab9601a8/drf_dynamic_fields-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "7924080697ddf436a91795d1bc69fed1",
                    "sha256": "05487348f03d533dbaf9b44094c2fbec45fd85c7da5c00a49513716407ad423e"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.1.0.tar.gz",
                "has_sig": true,
                "md5_digest": "7924080697ddf436a91795d1bc69fed1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2640,
                "upload_time": "2016-09-30T14:32:36",
                "url": "https://files.pythonhosted.org/packages/17/2f/fdd029d0351d76f63a0c321771c267801387d4b400d8d0b926c1f8602b61/drf_dynamic_fields-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c7a158672c06e3be770b36de149cd524",
                    "sha256": "300d271320ed4504470816064895296dd827aeebfb1c9157ad614557321f1c08"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.1.1-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "c7a158672c06e3be770b36de149cd524",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 5281,
                "upload_time": "2016-10-16T12:49:45",
                "url": "https://files.pythonhosted.org/packages/64/06/e067020dd5b9e346f3b729ada642aa03ce1f6806f00a4ed4a276d25611d7/drf_dynamic_fields-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "989bc87429bce8274d66e9272ba6ca47",
                    "sha256": "252e5aa67dee53cffc5b48ce28fd4ba32b3c9cfdf5c953414d8cf85a11ba89ce"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.1.1.tar.gz",
                "has_sig": true,
                "md5_digest": "989bc87429bce8274d66e9272ba6ca47",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3013,
                "upload_time": "2016-10-16T12:49:47",
                "url": "https://files.pythonhosted.org/packages/bf/c1/f9f70ddc5bfb542ce7e0137586f756d75952cfaca2cfa4f430be2c4ed57a/drf_dynamic_fields-0.1.1.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "97bbbd800983d02983054d6f90526a9c",
                    "sha256": "90aa50b03b0bb6ee27d37fdb8794e8c849a5f6a900aa41a39b03c873049c2029"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.2.0-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "97bbbd800983d02983054d6f90526a9c",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 5990,
                "upload_time": "2017-04-07T13:22:08",
                "url": "https://files.pythonhosted.org/packages/b4/86/492366db2071fb8def7a51f974cfc154c02d8323939b42005262ea7294c9/drf_dynamic_fields-0.2.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e841924c9df3eec1e3c8f7ea3d5d4796",
                    "sha256": "6c4401b4f939204974ee35b1c9f51f0e0afde6c63f6a6874bfb1d981ccb728e2"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.2.0.tar.gz",
                "has_sig": true,
                "md5_digest": "e841924c9df3eec1e3c8f7ea3d5d4796",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3553,
                "upload_time": "2017-04-07T13:22:11",
                "url": "https://files.pythonhosted.org/packages/62/8e/c05f2f4671ab634670cf70dc9a9e0ddbb4e27964d9892581c722b7230b97/drf_dynamic_fields-0.2.0.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9c939228d73f218214720791d2a2700b",
                    "sha256": "5da7d856f411561cb25d6ce3a0a152c2bd441d41a81b279ca0fec214d14c6134"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.3.0-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "9c939228d73f218214720791d2a2700b",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 6615,
                "upload_time": "2018-03-03T18:30:35",
                "url": "https://files.pythonhosted.org/packages/5b/1e/53b0534ea981eb62b4e0cc695e589586b4d111cc0e2e4bbad498f32d2b3f/drf_dynamic_fields-0.3.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2b96c5eadf469e85b0e3651a0aca91dc",
                    "sha256": "245eed41664976451b51ab9b59af179692ab6d8ee260a6b85ac2d44d2b06f5b4"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.3.0.tar.gz",
                "has_sig": true,
                "md5_digest": "2b96c5eadf469e85b0e3651a0aca91dc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4013,
                "upload_time": "2018-03-03T18:30:37",
                "url": "https://files.pythonhosted.org/packages/ea/93/47a00626ee1b6764932cc8d3fea318cb17fc1554f30fd4b13c84291aed7d/drf_dynamic_fields-0.3.0.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "de2469e837ac3d9dddb0f7877fe7fa42",
                    "sha256": "fa5a7ea010476184d776b4b977d57d0090e651e8f897d83ed0c2f2bca9cbf704"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.3.1-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "de2469e837ac3d9dddb0f7877fe7fa42",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 5442,
                "upload_time": "2019-03-01T15:49:52",
                "url": "https://files.pythonhosted.org/packages/56/a5/a8a7a8ab55266489e25bc8947af25572d0f72a1685f9cd7e2ff7bd6d4fe7/drf_dynamic_fields-0.3.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ad5bf411b0de836084ba6d50463466eb",
                    "sha256": "de75969abff74332f339d082931f1815dc91c2ff1ed6e741bd33d1d5057dceb1"
                },
                "downloads": -1,
                "filename": "drf_dynamic_fields-0.3.1.tar.gz",
                "has_sig": true,
                "md5_digest": "ad5bf411b0de836084ba6d50463466eb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4385,
                "upload_time": "2019-03-01T15:49:54",
                "url": "https://files.pythonhosted.org/packages/0b/ca/4e9a2aa43b311a4b30c012e579ff424ae3ab1e0ef74598a727872aeb3ec5/drf_dynamic_fields-0.3.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "de2469e837ac3d9dddb0f7877fe7fa42",
                "sha256": "fa5a7ea010476184d776b4b977d57d0090e651e8f897d83ed0c2f2bca9cbf704"
            },
            "downloads": -1,
            "filename": "drf_dynamic_fields-0.3.1-py2.py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "de2469e837ac3d9dddb0f7877fe7fa42",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 5442,
            "upload_time": "2019-03-01T15:49:52",
            "url": "https://files.pythonhosted.org/packages/56/a5/a8a7a8ab55266489e25bc8947af25572d0f72a1685f9cd7e2ff7bd6d4fe7/drf_dynamic_fields-0.3.1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ad5bf411b0de836084ba6d50463466eb",
                "sha256": "de75969abff74332f339d082931f1815dc91c2ff1ed6e741bd33d1d5057dceb1"
            },
            "downloads": -1,
            "filename": "drf_dynamic_fields-0.3.1.tar.gz",
            "has_sig": true,
            "md5_digest": "ad5bf411b0de836084ba6d50463466eb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4385,
            "upload_time": "2019-03-01T15:49:54",
            "url": "https://files.pythonhosted.org/packages/0b/ca/4e9a2aa43b311a4b30c012e579ff424ae3ab1e0ef74598a727872aeb3ec5/drf_dynamic_fields-0.3.1.tar.gz"
        }
    ]
}