{ "info": { "author": "Shan Valleru", "author_email": "shanvalleru@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.9", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "Vanguard is a simple API authentication library for Django REST Framework\r\n\r\nQuick start\r\n-----------\r\n0. Install `vanguard` using `pip`\r\n`pip install vanguard`\r\n\r\n1. Add \"vanguard\" to your INSTALLED_APPS setting like this::\r\n```\r\nINSTALLED_APPS = [\r\n ...\r\n 'rest_framework',\r\n 'vanguard',\r\n ...\r\n ]\r\n```\r\n\r\n2. Include the vanguard URLconf in your project urls.py like this::\r\n```\r\nfrom django.conf.urls import include\r\n:\r\nurl(r'^vanguard/', include('vanguard.urls')),\r\n```\r\n\r\n3. Run `python manage.py migrate` to create the vanguard models.\r\n\r\n4. Available vanguard endpoints\r\n```\r\nSignup [vanguard/, vanguard/signup]\r\nLogin [vanguard/login]\r\nPassword Retieval [vanguard/forgotpassword]\r\nLogout [vanguard/logout]\r\n```\r\n\r\n5. Use @validate_token as the inner most annotation for any API end point method\r\nyou wanna authenticate\r\n``` \r\nfrom rest_framework.decorators import api_view, renderer_classes\r\nfrom rest_framework.renderers import JSONRenderer, BrowsableAPIRenderer, status\r\nfrom rest_framework.response import Response\r\n:\r\nfrom vanguard.utils import validate_token\r\n:\r\n.\r\n@api_view(['GET', 'POST'])\r\n@renderer_classes((JSONRenderer, BrowsableAPIRenderer,))\r\n@validate_token\r\ndef my_api(request):\r\n #On successful authentication, HTTP_TOKEN's value will be replaced by\r\n #authenticated user's email\r\n user_email=request.META['HTTP_TOKEN']\r\n :\r\n return Response({'Authenticated User': request.META['HTTP_TOKEN']}, status=status.HTTP_200_OK)\r\n```", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/svalleru/vanguard", "keywords": "Django REST Framework Authentication,API Authentication", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "vanguard", "package_url": "https://pypi.org/project/vanguard/", "platform": "", "project_url": "https://pypi.org/project/vanguard/", "project_urls": { "Homepage": "https://github.com/svalleru/vanguard" }, "release_url": "https://pypi.org/project/vanguard/0.0.2/", "requires_dist": null, "requires_python": "", "summary": "A simple API authentication library for Django REST Framework", "version": "0.0.2" }, "last_serial": 2197037, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "e96a366f927f92439125ff99fa80d2d3", "sha256": "dfebcbd345f3ce887f9401ccee5cba98bea966aa1e9675d16761b4dab5f9132a" }, "downloads": -1, "filename": "vanguard-0.0.2.tar.gz", "has_sig": false, "md5_digest": "e96a366f927f92439125ff99fa80d2d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6716, "upload_time": "2016-06-30T20:54:35", "url": "https://files.pythonhosted.org/packages/80/89/10c075d4a8254ba7baf4caf16877ee365c5c655d66eceda36c095b4c9008/vanguard-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e96a366f927f92439125ff99fa80d2d3", "sha256": "dfebcbd345f3ce887f9401ccee5cba98bea966aa1e9675d16761b4dab5f9132a" }, "downloads": -1, "filename": "vanguard-0.0.2.tar.gz", "has_sig": false, "md5_digest": "e96a366f927f92439125ff99fa80d2d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6716, "upload_time": "2016-06-30T20:54:35", "url": "https://files.pythonhosted.org/packages/80/89/10c075d4a8254ba7baf4caf16877ee365c5c655d66eceda36c095b4c9008/vanguard-0.0.2.tar.gz" } ] }