{ "info": { "author": "Vladimir Myshkovski", "author_email": "vladimirmyshkovski@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Django :: 2.0", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "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" ], "description": "=============================\nDjango-simple-referrals\n=============================\n\n.. image:: https://badge.fury.io/py/django-simple-referrals.svg\n :target: https://badge.fury.io/py/django-simple-referrals\n\n.. image:: https://travis-ci.org/narnikgamarnikus/django-simple-referrals.svg?branch=master\n :target: https://travis-ci.org/narnikgamarnikus/django-simple-referrals\n\n.. image:: https://codecov.io/gh/narnikgamarnikus/django-simple-referrals/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/narnikgamarnikus/django-simple-referrals\n\nA simple application that allows you to generate referral links and track referrals\n\nDocumentation\n-------------\n\nThere are two types of referral structure: flat and multilevel.\n\nA flat structure means that the user can have referrals, and they will all be on the same level.\n\nMultilevel structure means that the user can have children who, in turn, also have children, each of which will be on a level lower (deeper) than the parent.\n\n\nThe full documentation is at https://django-simple-referrals.readthedocs.io.\n\n\nQuickstart\n----------\n\nInstall referrals::\n\n pip install django-simple-referrals\n\nAdd it to your `INSTALLED_APPS`:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n 'referrals',\n ...\n )\n\nAdd referrals's URL patterns:\n\n.. code-block:: python\n\n from referrals import urls as referrals_urls\n\n\n urlpatterns = [\n ...\n url(r'^referrals/', include('referrals_urls', namespace='referrals')),\n ...\n ]\n\n\n\nUsage\n----------\n\n1) Override your SignupForm\n\n.. code-block:: python\n\n from referrals.widgets import ReferralWidget\n from referrals.fields import ReferralField\n\n class ReferralSignupForm(SignupForm):\n\n referral = ReferralField(widget=ReferralWidget())\n\n\n\n2) After registration, send a signal\n\nIf you want to use a flat structure:\n\n.. code-block:: python\n\n from referrals.signals import create_flat_referral\n\n create_flat_referral.send(sender=User, request, user)\n\n\n\nOr, if you want to use a multi-level structure\n\n.. code-block:: python\n\n from referrals.signals import create_multi_level_referral\n\n create_flat_referral.send(sender=User, request, user, 'position')\n\n\n\nWhere the 'position' must be 'child' or 'sibling'\n\nIf you pass the value \"child\", then a child will be created from the referral, by whose link the user has registered.\n\nIf you specify \"sibling\", you will create a referral that is at the same level as the user whose link the user is registered with.\n\n3) Template tags with referral link:\n::\n {% referrals %} # Import template tags\n\n {% token %} # Use in any place in your html code\n\nAn incompromise will be created with the button \"Copy\" by clicking on it, the referral link of this user will be copied to the clipboard.\n\n4) Export default variables:\n\n.. code-block:: python\n\n export DJANGO_REFERRALS_DEFAULT_INPUT_VALUE = '40ed41dc-d291-4358-ae4e-d3c07c2d67dc' # The token to be used by\n # default. WARNING: Must be uuid4 \n \n export DJANGO_REFERRALS_FORM_URL = 'http://localhost:8000/accounts/signup/' # The signup URL\n\n\n\n\n\nFeatures\n--------\n\n* TODO\n- Create a class for extracting the defaul UUID token\n- Eliminate a possible error, with a non uuid4 format token\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n::\n\n source /bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\nCredits\n-------\n\nTools used in rendering this package:\n\n* Cookiecutter_\n* `cookiecutter-djangopackage`_\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage\n\n\n\n\nHistory\n-------\n\n0.1.0 (2018-04-13)\n++++++++++++++++++\n\n* First release on PyPI.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/narnikgamarnikus/django-simple-referrals", "keywords": "django-simple-referrals", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "django-simple-referrals", "package_url": "https://pypi.org/project/django-simple-referrals/", "platform": "", "project_url": "https://pypi.org/project/django-simple-referrals/", "project_urls": { "Homepage": "https://github.com/narnikgamarnikus/django-simple-referrals" }, "release_url": "https://pypi.org/project/django-simple-referrals/0.2/", "requires_dist": null, "requires_python": "", "summary": "A simple application that allows you to generate referral links and track referrals", "version": "0.2" }, "last_serial": 3839601, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "b8ebfbb6f35363f78f8ccc7f7312eeeb", "sha256": "9361d387c958f28ea03e3ef3e0c98af4ad8969ac97974983db19b6efc091b3ab" }, "downloads": -1, "filename": "django-simple-referrals-0.1.0.tar.gz", "has_sig": false, "md5_digest": "b8ebfbb6f35363f78f8ccc7f7312eeeb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10141, "upload_time": "2018-04-15T11:39:24", "url": "https://files.pythonhosted.org/packages/31/5d/594a44e7c5793101866ce9d5ae1538e0e6fa933b062a47c1c72f0d4bdbf9/django-simple-referrals-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "e27f6e4a7b03b3fb0da4a02e384a0241", "sha256": "035020ed0dd986a456f26a2686ea949b77aa229671a043d2b6063161b3836e35" }, "downloads": -1, "filename": "django-simple-referrals-0.1.1.tar.gz", "has_sig": false, "md5_digest": "e27f6e4a7b03b3fb0da4a02e384a0241", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9594, "upload_time": "2018-04-15T14:26:30", "url": "https://files.pythonhosted.org/packages/37/91/15a4db15a4d33b9127f87815f1d02d5269244eff6ecdea06507202529e63/django-simple-referrals-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "16b88865ec1df74a0d5cb6835c562516", "sha256": "59a3ffe35e9b8c8712bf05261e4bcf179dcb73495e49d2bf103cf482da1695ce" }, "downloads": -1, "filename": "django-simple-referrals-0.1.2.tar.gz", "has_sig": false, "md5_digest": "16b88865ec1df74a0d5cb6835c562516", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9593, "upload_time": "2018-04-15T14:41:35", "url": "https://files.pythonhosted.org/packages/d1/cb/aaa129f1cab8c7353b79a0876539b9807facdd7f2a9afde4238df608e9b2/django-simple-referrals-0.1.2.tar.gz" } ], "0.1.21": [ { "comment_text": "", "digests": { "md5": "636031fb98a7011fde9540df18768ee4", "sha256": "5e325aa97b5ce2d4d49f898486aee6ddbf35ca948a7f0d339210481ad406dfd9" }, "downloads": -1, "filename": "django-simple-referrals-0.1.21.tar.gz", "has_sig": false, "md5_digest": "636031fb98a7011fde9540df18768ee4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9584, "upload_time": "2018-04-15T15:00:02", "url": "https://files.pythonhosted.org/packages/e3/24/6cd8300e6a25014f082b5b3b949c0fefc36e612d60942f2a5480cead4102/django-simple-referrals-0.1.21.tar.gz" } ], "0.1.22": [ { "comment_text": "", "digests": { "md5": "076d351dacb3dfd5265028e63b5a0018", "sha256": "e9187b44a4b445dc54d62cc92dc8d2bb3c5452cfc31161af33cc94d4eb3da96e" }, "downloads": -1, "filename": "django-simple-referrals-0.1.22.tar.gz", "has_sig": false, "md5_digest": "076d351dacb3dfd5265028e63b5a0018", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9608, "upload_time": "2018-04-16T07:54:27", "url": "https://files.pythonhosted.org/packages/59/8b/8f69ac339259e27b5518ec28e4077b6654d713c9f2e7922daee57e1c79ed/django-simple-referrals-0.1.22.tar.gz" } ], "0.1.23": [ { "comment_text": "", "digests": { "md5": "7cbd347fe4fad8d4cb079c32d3e6d038", "sha256": "e58be60c6bb585606451085667184b53bc5144676e840db2c0b2301a225b360a" }, "downloads": -1, "filename": "django-simple-referrals-0.1.23.tar.gz", "has_sig": false, "md5_digest": "7cbd347fe4fad8d4cb079c32d3e6d038", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9745, "upload_time": "2018-04-20T23:04:36", "url": "https://files.pythonhosted.org/packages/56/87/5740f6145e0d4b8e29b44d39fded7db8a054ae32a35c712e10a53473eb68/django-simple-referrals-0.1.23.tar.gz" } ], "0.1.24": [ { "comment_text": "", "digests": { "md5": "1297cff04328f4f9dd502c207e6f1ecf", "sha256": "f3adc7fb6bf7fb63cdea4d2022803eed3245c7d5fee2426ccac37477b3d259f3" }, "downloads": -1, "filename": "django-simple-referrals-0.1.24.tar.gz", "has_sig": false, "md5_digest": "1297cff04328f4f9dd502c207e6f1ecf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9746, "upload_time": "2018-04-20T23:05:20", "url": "https://files.pythonhosted.org/packages/71/8c/32943b3dcd45ac99405d18528f23a472921435e46f272e6c1ab4bffd9623/django-simple-referrals-0.1.24.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "04879e6a7074dc2e74d2404c62b09f52", "sha256": "367481c43293478aacdc2e5267bb6cb613846c2047f3cc54d73602cc841fda88" }, "downloads": -1, "filename": "django-simple-referrals-0.1.3.tar.gz", "has_sig": false, "md5_digest": "04879e6a7074dc2e74d2404c62b09f52", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9889, "upload_time": "2018-04-21T01:10:30", "url": "https://files.pythonhosted.org/packages/77/66/fe36ce7a7c7a6f95497f63cd770c5b1d10b17cdf5d1855bad866fca87fb0/django-simple-referrals-0.1.3.tar.gz" } ], "0.1.31": [ { "comment_text": "", "digests": { "md5": "8436d50e4c9634ea4ee938ed3d3da0bf", "sha256": "9b3dd856406d49165f8272fc999614b256e885c3767856a45838ebbc32445525" }, "downloads": -1, "filename": "django-simple-referrals-0.1.31.tar.gz", "has_sig": false, "md5_digest": "8436d50e4c9634ea4ee938ed3d3da0bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9999, "upload_time": "2018-04-21T04:12:31", "url": "https://files.pythonhosted.org/packages/67/a8/e25feb5e54f0540d79c581c7dafe52b6e2254cb2b37702640b9fdcb85ee3/django-simple-referrals-0.1.31.tar.gz" } ], "0.1.32": [ { "comment_text": "", "digests": { "md5": "7fe0e8d8d4c63f04213272c29b87482b", "sha256": "d731f65d8fb2689b7be7b4851475cafea3d3c0741b5600d7c132d0b20d87aa91" }, "downloads": -1, "filename": "django-simple-referrals-0.1.32.tar.gz", "has_sig": false, "md5_digest": "7fe0e8d8d4c63f04213272c29b87482b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10030, "upload_time": "2018-04-21T04:51:54", "url": "https://files.pythonhosted.org/packages/9e/7a/b292db3056d3b1c69e729805f3cb0d7d5bbaf51fd73592c49a2c2e25bb7a/django-simple-referrals-0.1.32.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "26737e6f058789a83ef072f3360fc904", "sha256": "37eb68d6bc4ad05635361a91748e1dc7c1c8584a04ac7d2ba08b46147f65ee58" }, "downloads": -1, "filename": "django-simple-referrals-0.2.tar.gz", "has_sig": false, "md5_digest": "26737e6f058789a83ef072f3360fc904", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10945, "upload_time": "2018-05-07T00:54:34", "url": "https://files.pythonhosted.org/packages/7f/73/266d70d6d0a077b958ea4fc35f45b95a2eeadede01615c1ecd83e76363f2/django-simple-referrals-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "26737e6f058789a83ef072f3360fc904", "sha256": "37eb68d6bc4ad05635361a91748e1dc7c1c8584a04ac7d2ba08b46147f65ee58" }, "downloads": -1, "filename": "django-simple-referrals-0.2.tar.gz", "has_sig": false, "md5_digest": "26737e6f058789a83ef072f3360fc904", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10945, "upload_time": "2018-05-07T00:54:34", "url": "https://files.pythonhosted.org/packages/7f/73/266d70d6d0a077b958ea4fc35f45b95a2eeadede01615c1ecd83e76363f2/django-simple-referrals-0.2.tar.gz" } ] }