Skip to main content

A simple API authentication library for Django REST Framework

Project description

Vanguard is a simple API authentication library for Django REST Framework

Quick start
0. Install `vanguard` using `pip`
`pip install vanguard`

1. Add "vanguard" to your INSTALLED_APPS setting like this::

2. Include the vanguard URLconf in your project like this::
from django.conf.urls import include
url(r'^vanguard/', include('vanguard.urls')),

3. Run `python migrate` to create the vanguard models.

4. Available vanguard endpoints
Signup [vanguard/, vanguard/signup]
Login [vanguard/login]
Password Retieval [vanguard/forgotpassword]
Logout [vanguard/logout]

5. Use @validate_token as the inner most annotation for any API end point method
you wanna authenticate
from rest_framework.decorators import api_view, renderer_classes
from rest_framework.renderers import JSONRenderer, BrowsableAPIRenderer, status
from rest_framework.response import Response
from vanguard.utils import validate_token
@api_view(['GET', 'POST'])
@renderer_classes((JSONRenderer, BrowsableAPIRenderer,))
def my_api(request):
#On successful authentication, HTTP_TOKEN's value will be replaced by
#authenticated user's email
return Response({'Authenticated User': request.META['HTTP_TOKEN']}, status=status.HTTP_200_OK)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vanguard-0.0.2.tar.gz (6.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page