Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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::
```
INSTALLED_APPS = [
...
'rest_framework',
'vanguard',
...
]
```

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

3. Run `python manage.py 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,))
@validate_token
def my_api(request):
#On successful authentication, HTTP_TOKEN's value will be replaced by
#authenticated user's email
user_email=request.META['HTTP_TOKEN']
:
return Response({'Authenticated User': request.META['HTTP_TOKEN']}, status=status.HTTP_200_OK)
```

Release History

This version
History Node

0.0.2

Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
vanguard-0.0.2.tar.gz
(6.7 kB) Copy SHA256 Hash SHA256
Source None Jun 30, 2016

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting