{
    "info": {
        "author": "iwoca ltd",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Web Environment",
            "Framework :: Django",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD 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 :: Internet :: WWW/HTTP :: Dynamic Content"
        ],
        "description": "==============\nDeep Collector\n==============\n\n.. image:: https://travis-ci.org/iwoca/django-deep-collector.svg?branch=master\n    :target: https://travis-ci.org/iwoca/django-deep-collector.svg\n\nDjango custom collector used to get every objects that are related to given object.\n\nInstall\n=======\n\n.. code-block:: python\n    pip install django-deep-collector\n\nUsage\n=====\n\nCreate a new instance of DeepCollector, and launch collector on one object:\n\n.. code-block:: python\n\n    from deep_collector.core import DeepCollector\n    from django.contrib.auth.models import User\n\n    user = User.objects.all()[0]\n    collector = DeepCollector()\n    collector.collect(user)\n    related_objects = collector.get_collected_objects()\n\nIf you want to save it in a file to be 'django load_data'-like imported, you can use:\n\n.. code-block:: python\n\n    string_buffer = collector.get_json_serialized_objects()\n\n\nHow it works\n============\n\nThis class is used to introspect an object, to get every other objects that depend on it, following its\n'relation' fields, i.e. ForeignKey, OneToOneField, ManyToManyField, GenericForeignKey and GenericRelation.\n\n1. We start from given object (of class classA for example), and loop over :\n\n- Its 'direct' fields, it means the relation fields that are explicitly declared in this django model.\n\n.. code-block:: python\n\n    class classA(models.Model):\n        fkey = models.ForeignKey(classB)\n        o2o = models.OneToOneField(classC)\n        m2m = models.ManyToManyField(classD)\n\n\n- Its 'related' fields, so other django model that are related to this object by relation fields.\n\n.. code-block:: python\n\n    class classB(models.Model):\n        fkeyto = models.ForeignKey(classA)\n\n    class classC(models.Model):\n        o2oto = models.OneToOneField(classA)\n\n    class classD(models.Model):\n        m2mto = models.ManyToManyField(classA)\n\n\n2. For every field, we get associated object(s) of objA:\n\n- If it's a direct field, we get objects by:\n\n.. code-block:: python\n\n    class classA(models.Model):\n        fkey = models.ForeignKey(classB)        # objA.fkey\n        o2o = models.OneToOneField(classC)      # objA.o2o\n        m2m = models.ManyToManyField(classD)    # objA.m2m.all()\n\n\n- If it's a related field, we get objects by:\n\n.. code-block:: python\n\n    class classB(models.Model):\n        fkeyto = models.ForeignKey(classA)      # objA.classb_set.all()\n\n    class classC(models.Model):\n        o2oto = models.OneToOneField(classA)    # objA.classC (not a manager, because OneToOneField is a unique rel)\n\n    class classD(models.Model):\n        m2mto = models.ManyToManyField(classA)  # objA.classd_set.all()\n\n\nIf we are using related_name attribute, then we access manager with its related_name:\n\n.. code-block:: python\n\n    class classE(models.Model):\n        m2mto = models.ForeignKey(classA, related_name='classE')  # objA.classE.all()\n\n3. For each associated object, we go back to step 1. and get every field, ...\n\n\nGenericForeignKey\n=================\n\nThe `GenericForeignKey` has a small exception. If you want it to be collected in the \"reverse\" way, you should\nexplicitly define a `GenericRelation` in the models you want to follow this \"reverse\" relation.\n\n.. code-block:: python\n\n    class GFKModel(models.Model):\n        content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)\n        object_id = models.PositiveIntegerField()\n        content_object = GenericForeignKey('content_type', 'object_id')\n\n\n    class BaseToGFKModel(models.Model):\n        gfk_relation = GenericRelation(GFKModel)\n\nIn above example, if you collect a `BaseToGFKModel` instance, the collector will look for all `GFKModel` instances\nrelated to your initial `BaseToGFKModel` instance.\nThat happens because the `BaseToGFKModel` model explicitly defines a `GenericRelation`.\n\n\nParameters\n==========\n\nYou can customize which model/field is collected.\nBy default, every model and field is collected, but you can override some parameters to have custom behaviour:\n\n- `EXCLUDE_MODELS`: exclude models (expecting a list of '<app_label>.<module_name>')\n\n.. code-block:: python\n\n    EXCLUDE_MODELS = ['sites.site', 'auth.permission', 'auth.group']\n\nEvery time we will try to collect an object of this model type, it won't be collected.\n\n- `EXCLUDE_DIRECT_FIELDS`: exclude direct fields from specified models\n\n.. code-block:: python\n\n    EXCLUDE_DIRECT_FIELDS = {\n        'auth.user': ['groups'],\n    }\n\nOn User model, when we will get direct fields, we won't take into account 'groups' field.\n\n- `EXCLUDE_RELATED_FIELDS`: exclude related fields from specified models\n\n.. code-block:: python\n\n    EXCLUDE_RELATED_FIELDS = {\n        'auth.user': ['session_set']\n    }\n\nOn User model, we don't want to collect sessions that are associated to this user, so we put the exact accessor name we have to use to get these sessions, 'session_set', to exclude them from collection.\n\n- `ALLOWS_SAME_TYPE_AS_ROOT_COLLECT`: avoid by default to collect objects that have the same type as the root one, to prevent collecting too many data.\n\nMiscellaneous\n=============\n\nTo avoid some recursive collect between 2 objects (if an object has a direct field to another one, it means that other object has a related field to this first one), we detect if an object has already been collected before trying to collect it.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/iwoca/django-deep-collector/",
        "keywords": "",
        "license": "BSD License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "django-deep-collector",
        "package_url": "https://pypi.org/project/django-deep-collector/",
        "platform": "",
        "project_url": "https://pypi.org/project/django-deep-collector/",
        "project_urls": {
            "Homepage": "http://github.com/iwoca/django-deep-collector/"
        },
        "release_url": "https://pypi.org/project/django-deep-collector/0.5.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A simple Django app to collect related objects.",
        "version": "0.5.0"
    },
    "last_serial": 4888620,
    "releases": {
        "0.1": [],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "263f3903240a168c4f72dd19129003db",
                    "sha256": "20e5bacc5dbed0f7dca91a6b806444a9570657894b6be8c20c8e49537f1a81a1"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "263f3903240a168c4f72dd19129003db",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8602,
                "upload_time": "2016-02-02T16:23:26",
                "url": "https://files.pythonhosted.org/packages/ea/53/529a2d2568f522a4412591b91d8c233a527e9b8a179f0be8b5fe2a76d0bc/django-deep-collector-0.1.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9f6601b8db0ce24b0c6471d03abac8b4",
                    "sha256": "0b2f2bc8ac25733821cf4daf35470c53615c443353ed0ea5df8a4de54d85694d"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "9f6601b8db0ce24b0c6471d03abac8b4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7753,
                "upload_time": "2016-02-02T18:21:53",
                "url": "https://files.pythonhosted.org/packages/ad/04/7a704e88357ff66cf2f93e71b58e2395b31ce7f9c277389e9feb48a24e5e/django-deep-collector-0.2.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f8e25dd8ee92e3a64a3e37622b75d09c",
                    "sha256": "eabdf28a59993e752b2eefa9d81449163077ceef15326576f625423357d47d31"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f8e25dd8ee92e3a64a3e37622b75d09c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10924,
                "upload_time": "2016-02-03T16:04:12",
                "url": "https://files.pythonhosted.org/packages/42/3d/92206c87054c7ec85283b0d6e70357e4e3d41b8f625927cf2284f68f37c2/django-deep-collector-0.2.1.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2027caa96ae7eeecd479c0de6d237b6c",
                    "sha256": "be55e6d1c33c7cac95e759ded626ed46565e9416d2b56167d3f2531af3653fd8"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "2027caa96ae7eeecd479c0de6d237b6c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11374,
                "upload_time": "2016-02-11T18:15:29",
                "url": "https://files.pythonhosted.org/packages/d7/62/299b5ee88caa06696799e766d9451af72a37c82a3bbedafe1c65badc4b93/django-deep-collector-0.3.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "74fedd036f085dffc566a357059cd90e",
                    "sha256": "f6ee1a0fb95ddd98359a23f42e93ea9a614c757c52fd697ab4b5bbaf7e7149a1"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "74fedd036f085dffc566a357059cd90e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11399,
                "upload_time": "2016-04-06T18:41:34",
                "url": "https://files.pythonhosted.org/packages/02/5b/83640fbbeb122c7b0b36c6c53304db8d8040fdfdcbdc743b333f52daec10/django-deep-collector-0.3.1.tar.gz"
            }
        ],
        "0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1081648a5467b91bc431f5de7100b708",
                    "sha256": "02863789a6985c8e4a12347e168457fb730551056bd48722f17b1a64d561d61b"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "1081648a5467b91bc431f5de7100b708",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12493,
                "upload_time": "2016-06-19T15:08:23",
                "url": "https://files.pythonhosted.org/packages/28/dc/71e24b81543439fe8fa3c8f05d79239f7381b7300132dc4d58c48aa18651/django-deep-collector-0.4.tar.gz"
            }
        ],
        "0.4.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "dbeb43f9eeeb72bf609cd111c8a4c4fd",
                    "sha256": "6b46106908beae243a40bfb78495d070579483f7dcb4546f3b7f6ad55b276b44"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.4.1.tar.gz",
                "has_sig": false,
                "md5_digest": "dbeb43f9eeeb72bf609cd111c8a4c4fd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13073,
                "upload_time": "2016-06-29T12:20:42",
                "url": "https://files.pythonhosted.org/packages/c1/e4/c0dc9bc9001c3aea5952dcd5ce4d1ca22ec093aced124d2d896181710627/django-deep-collector-0.4.1.tar.gz"
            }
        ],
        "0.4.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b4f2f3ca3a3ab823b09db50145f6735b",
                    "sha256": "2bdb4471c5cbf358ec32ef53bbbd70a9914752cd476a49ea79d9616fa443db62"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.4.2.tar.gz",
                "has_sig": false,
                "md5_digest": "b4f2f3ca3a3ab823b09db50145f6735b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13102,
                "upload_time": "2016-07-04T10:13:05",
                "url": "https://files.pythonhosted.org/packages/40/43/fac58eaaa14a1aa930a83b2d0effccae8a23319754c4d39b84e3c3c30efd/django-deep-collector-0.4.2.tar.gz"
            }
        ],
        "0.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "32f8439e4efc695112eb80b0618447fa",
                    "sha256": "e28b0db38ff0f56d0d1b29882b61c4e0f6c75faaf2029d0ec4ca60d8ba6fcf79"
                },
                "downloads": -1,
                "filename": "django-deep-collector-0.5.0.tar.gz",
                "has_sig": false,
                "md5_digest": "32f8439e4efc695112eb80b0618447fa",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10799,
                "upload_time": "2019-03-02T16:15:07",
                "url": "https://files.pythonhosted.org/packages/40/de/8c605379413efb1d75bd3c88bc5312540834d2eb3013cd9a9c89a600647f/django-deep-collector-0.5.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "32f8439e4efc695112eb80b0618447fa",
                "sha256": "e28b0db38ff0f56d0d1b29882b61c4e0f6c75faaf2029d0ec4ca60d8ba6fcf79"
            },
            "downloads": -1,
            "filename": "django-deep-collector-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "32f8439e4efc695112eb80b0618447fa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10799,
            "upload_time": "2019-03-02T16:15:07",
            "url": "https://files.pythonhosted.org/packages/40/de/8c605379413efb1d75bd3c88bc5312540834d2eb3013cd9a9c89a600647f/django-deep-collector-0.5.0.tar.gz"
        }
    ]
}