Skip to main content

Replyify OAuth2 consumer for Django

Project description

A Django wrapper for Replyify’s Python API bindings.

Installation

You can install this package by using the pip tool and installing:

$ pip install django-replyify-oauth2

Or:

$ easy_install django-replyify-oauth2

Register Your Application with Replyify

Configure the django-replyify-oauth2 module

From your previously configured app, found at https://app.replyify.com/oauth2/applications add the following to your Django settings.py:

REPLYIFY_CLIENT_ID = '{ update me }'
REPLYIFY_CLIENT_SECRET = '{ update me }'
REPLYIFY_REDIRECT_URI = '{ update me, must match value set from previous step'
REPLYIFY_USER_ID_FIELD = 'id'  # or other primary key user field like `guid`
REPLYIFY_DENIED_REDIRECT = '/path/when/user/denies/access'  # defaults to home page

INSTALLED_APPS = [
    ...
    'replyify_oauth2',
    ...
]

And add the following to your urls.py

from django.conf.urls import patterns, include, url
urlpatterns = patterns(
    ...
    url(r'^replyify/', include('replyify_oauth2.urls', namespace='replyify')),
    ...
)

Run migrate

**$ python manage.py migrate**

In templates

<a href="{% url 'replyify:authorize' %}?next={% url 'home'|urlencode %}">Connect to Replyify</a>

Note: you can pass next query parameter to the authorize view to direct the user to correct page after OAuth flow has completed successfully. Default will send user to ‘/’

In views as a decorator: this will kick off the Authorization flow or Refresh request (if token is expired) and will send the user back to the original requested url on completion

from replyify_oauth2.decorators import replyify_auth_required

@replyify_auth_required
def my_view_that_needs_replyify(request):
    ...

Using the Replyify API

Documentation for the python bindings can be found here:

In the standard documentation (the first link), most of the reference pages will have examples in Replyify’s official bindings (including Python). Just click on the Python tab to get the relevant documentation.

In the full API reference for python (the second link), the right half of the page will provide example requests and responses for various API calls.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

django_replyify_oauth2-0.1.1-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file django_replyify_oauth2-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_replyify_oauth2-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 953a391181d2373b78ea6b261d5f151764645a6dac04044a23b9af651f8abcdb
MD5 21d2fab2e4fd0da97b580e98842497c2
BLAKE2b-256 9869c16daf28dc54f3e3f1e2064d13ad22797c443b0432025d07a447452e720b

See more details on using hashes here.

Supported by

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