Skip to main content

Single Sign-On functionallity between Django and Freshdesk

Project description

Build Status Coverage https://coveralls.io/repos/ThatGreenSpace/django-freshdesk/badge.png?branch=master Pypi version Code health Documentation Status

Single Sign-On functionallity between Django and Freshdesk.

The Freshdesk documentation for Single Sign-On is located at Freshdesk documentation

How to use

Get the code

Getting the code for the latest stable release using pip:

$ pip install django-freshdesk

You can also download the source and run:

$ python setup.py install

Add the application to the project settings

Make sure that .django.contrib.auth’ is installed and then add register ‘freshdesk’ in the ‘INSTALLED_APPS’ section of your project’s settings

INSTALLED_APPS = (
    ...
    'django.contrib.auth',
    'freshdesk',
)

Setup the settings variables

You must specify two settings variables in your settings module.

  • The URL of your support page, will either a subdomain in freshdesk.com or your own domain (using a CNAME record)

FRESHDESK_URL = 'http://yourcompany.freshdesk.com/'
  • The shared secret you get from Freshdesk when setting up Simple SSO

FRESHDESK_SECRET_KEY = '098f6bcd4621d373cade4e832627b4f6'

Register the urls

Add the application urls to your urlconf

urlpatterns = [
    ...
    url(r'^login/sso/', include('freshdesk.urls')),
]

Requirements

  • Python 2.7, 3.4, 3.5 or 3.6

  • Django >= 1.8

Bugs and requests

If you have found a bug or or you have a ny request, please use the issue tracker on GitHub.

https://github.com/ThatGreenSpace/django-freshdesk/issues

License

You can use this software under BSD License.

History

1.1.0

  • Add name to authenticate url

  • Add support for Django 1.11 and Python 3.6

1.0.1

  • Unicode first

1.0.0

  • Add support for Django 1.10

0.4.0

  • Change data for HMAC-MD5 per Freshdesk’s change.

0.3.0

  • Add Tox environments for Django 1.8 using Python 2.7, 3.3, 3.4

0.2.2

  • Fix Django version compatibility. Django 1.5 not supported anymore.

0.2.1

  • Username as default if not first and last name defined

0.1.4

  • Serveral fixes and updated doc

0.1.0

  • Initial application

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

django-freshdesk-1.1.1.tar.gz (5.6 kB view hashes)

Uploaded Source

Built Distribution

django_freshdesk-1.1.1-py2.py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 2 Python 3

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