{
    "info": {
        "author": "akuryou",
        "author_email": "contact@byteweaver.net",
        "bugtrack_url": null,
        "classifiers": [
            "Framework :: Django",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4"
        ],
        "description": "# django-referral\n\n![build status](https://travis-ci.org/byteweaver/django-referral.png)\n\nA small django application for marketing using referral links\n\n## What is this app good for?\n\nImagine you got a nice website running and you want to make some marketing in order to gain more users.\nThis can be achieved by spreading links/banners over the internet pointing to your website.\nNow in order to find out how your banners performed you need to know how many users registered\nafter clicking on one of your banners. To tell them apart you add some unique GET parameter to\neach link. This app will detect those referral parameters and store for each user what referrer\nlead him to your website.\n\n## Key Features\n\n* Manual and automatic referrer generation.\n* Referrer organisation in campaigns.\n* Automatic associating of referrers with campaigns using patterns.\n* Referrers will be cached in sessions, so when a user first browses your site and does not\n  immediately register the referrer will be cached and assigned when the user finally decides\n  to register. That way you can link to any site and not necessarily a register page.\n* Very easy integration.\n* Completely configurable to your needs.\n* django 1.7 migrations + legacy south support\n* No dependencies\n* 100% Test coverage\n* Supports django 1.4 - 1.7\n* supports python 2 + 3\n\n## Download\n\n### using pip\n\n\tpip install django-referral\n\t\n### github\n\n\thttps://github.com/byteweaver/django-referral\n\t\n## Integration\n\n### 1. Add referral to your INSTALLED_APPS\n\n\tINSTALLED_APPS = (\n\t\t...\n\t\t'referral',\n\t\t...\n\t)\n\n### 2. Add ReferrerMiddleware to your MIDDLEWARE_CLASSES\n\nSince django-referral uses django's session middleware make sure you add it after SessionMiddleware\n\n\tMIDDLEWARE_CLASSES = (\n\t\t...\n\t\t'django.contrib.sessions.middleware.SessionMiddleware',\n\t\t'referral.middleware.ReferrerMiddleware',\n\t\t...\n\t)\n\n### 3. Trigger the referrer association after user creation\n\n\tfrom referral.models import UserReferrer\n\t...\n\tdef my_user_creation_view(request):\n\t\t...\n\t\tUserReferrer.objects.apply_referrer(user, request)\n\n## Settings\n\n###REFERRAL_GET_PARAMETER\n\nThe name of the GET parameter used.\n\n\tDefault: \"ref\"\n\n###REFERRAL_SESSION_KEY\n\nThe name of the session key that will hold the detected referrer\n\n\tDefault: \"referrer\"\n\n###REFERRAL_AUTO_CREATE\n\nDefines whether unknown referrers shall be autocreated\n\n\tDefault: True\n\n###REFERRAL_AUTO_ASSOCIATE\nDefines whether referrers should be associated to campaigns automatically using patterns\n\n\tDefault: True\n\n###REFERRAL_CASE_SENSITIVE\nDefines whether or referrer names are case-sensitive or not.\n\n  Default: False\n\n## Testing\n\nJust run the makefile to set up a virtual environment for testing\n\n\tmake\n\nFor simple test\n\n\tmake test\n\nFor coverage report\n\n\tmake coverage\n\nFor full test in all supported environment (requires tox)\n\n\ttox\n\n## Changelog\n### V1.0.0\n* add django 1.7 support\n* add pyton3 support\n* additional test cases\n* code cleanup\n* some pep8 fixes",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/byteweaver/django-referral",
        "keywords": null,
        "license": "Copyright (c) 2014 byteweaver\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-referral",
        "package_url": "https://pypi.org/project/django-referral/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/django-referral/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/byteweaver/django-referral"
        },
        "release_url": "https://pypi.org/project/django-referral/1.0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "A small django application for marketing using referral links",
        "version": "1.0.1"
    },
    "last_serial": 1428189,
    "releases": {
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c0705a6fe1df6830c44d7a556ed4499",
                    "sha256": "0b672273f92742aabcf0df669d3fd5823768d8660a17811f30da68c5baa4057f"
                },
                "downloads": -1,
                "filename": "django-referral-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6c0705a6fe1df6830c44d7a556ed4499",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7949,
                "upload_time": "2012-08-31T22:46:56",
                "url": "https://files.pythonhosted.org/packages/54/24/964530c0cea7818ba3fb3f8560f298aea1725d93c5e612fac2f8ddfe2408/django-referral-0.3.1.tar.gz"
            }
        ],
        "0.9.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e0c321d3e60c4e529d3b8be142c84ba6",
                    "sha256": "f77116d0fd8d169a72a7ba08f6a2c9e7780dae5976acd9040b5ac36da1119277"
                },
                "downloads": -1,
                "filename": "django-referral-0.9.0.tar.gz",
                "has_sig": false,
                "md5_digest": "e0c321d3e60c4e529d3b8be142c84ba6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9539,
                "upload_time": "2012-09-05T19:18:06",
                "url": "https://files.pythonhosted.org/packages/7f/27/c45bb983a920a2a4b53979325f45a256c0559abdcf0200f41d11c24c3118/django-referral-0.9.0.tar.gz"
            }
        ],
        "0.9.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "dba49abd9977e8d061af076ab5fb954d",
                    "sha256": "6b9587cbf2cbfc9946c5f6c4719c93fdb1ada4ec09cff13f05e23047725a8225"
                },
                "downloads": -1,
                "filename": "django-referral-0.9.1.tar.gz",
                "has_sig": false,
                "md5_digest": "dba49abd9977e8d061af076ab5fb954d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9544,
                "upload_time": "2012-09-05T19:41:48",
                "url": "https://files.pythonhosted.org/packages/a8/92/dc6407c53fd4360787de2ac6443dabec9b8b6c5b7dbb57294e7250a8a659/django-referral-0.9.1.tar.gz"
            }
        ],
        "0.9.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4c168776319295bca449790228909475",
                    "sha256": "334d46e718591131d1b6bb2401354fc4de2b456f074448d73ebac2208b554ff3"
                },
                "downloads": -1,
                "filename": "django-referral-0.9.2.tar.gz",
                "has_sig": false,
                "md5_digest": "4c168776319295bca449790228909475",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9423,
                "upload_time": "2014-03-10T15:22:31",
                "url": "https://files.pythonhosted.org/packages/12/b7/31cdb79ca6a2a0e7d648ce0c1337e84fc3178a3f379a29b478959d331e8e/django-referral-0.9.2.tar.gz"
            }
        ],
        "0.9.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c31b467d280ca8d1eba3bfd48f3eb2c6",
                    "sha256": "a7115f1eb04bb8e4a1ee9c0a1fff57b34fb6455eabfdf01304ed688dcb8768e6"
                },
                "downloads": -1,
                "filename": "django-referral-0.9.3.tar.gz",
                "has_sig": false,
                "md5_digest": "c31b467d280ca8d1eba3bfd48f3eb2c6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9466,
                "upload_time": "2014-09-24T11:54:09",
                "url": "https://files.pythonhosted.org/packages/df/18/506fb9071e497445c575747482895740012e9a1ee848733bc032ea66b56d/django-referral-0.9.3.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c98fb374430fd7bf16a0475e83b2fa6e",
                    "sha256": "18b65a28039dfc5f977600797122d9ec4b14749b9fd36b74474b53691443258f"
                },
                "downloads": -1,
                "filename": "django-referral-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "c98fb374430fd7bf16a0475e83b2fa6e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9492,
                "upload_time": "2014-11-25T10:07:23",
                "url": "https://files.pythonhosted.org/packages/56/db/2674f22d253b7787693c67008e1b00c58f52c161134111a77ed6f34b6f73/django-referral-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e83a5ceca6cf7450f66fc221411f165b",
                    "sha256": "7bc51146eff3610227558c418a3787d4221b9c7511d785b0a3cd0034f13b0d66"
                },
                "downloads": -1,
                "filename": "django-referral-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "e83a5ceca6cf7450f66fc221411f165b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10105,
                "upload_time": "2015-02-18T08:56:47",
                "url": "https://files.pythonhosted.org/packages/9a/0c/40a639785862fc4f62170b2f778c9f02920d114a74a065a972607646578f/django-referral-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e83a5ceca6cf7450f66fc221411f165b",
                "sha256": "7bc51146eff3610227558c418a3787d4221b9c7511d785b0a3cd0034f13b0d66"
            },
            "downloads": -1,
            "filename": "django-referral-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e83a5ceca6cf7450f66fc221411f165b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10105,
            "upload_time": "2015-02-18T08:56:47",
            "url": "https://files.pythonhosted.org/packages/9a/0c/40a639785862fc4f62170b2f778c9f02920d114a74a065a972607646578f/django-referral-1.0.1.tar.gz"
        }
    ]
}