Skip to main content

Provides single-sign on functionality between a django.contrib.auth based site and Zendesk

Project description

Django Zendesk

django_zendesk provides single-sign on functionality between a django.contrib.auth based site and Zendesk. Other authentication systems are compatible as long as they implement the @login_required decorator. This differs from the other implementations in that it exposes out company, external_id, tags, etc.

Note:

This fork provides for changes specifically for Pivotal Energy Solutions

SETUP

django_zendesk needs two settings.py variables to be implemented:

  • ZENDESK_URL : The URL of your support page, will either be on zendesk.com or your own domain (via a CNAME record)
  • ZENDESK_TOKEN : The authentication token token you receive from Zendesk when setting up remote authentication

The only other code setup required is pointing a URL at the django_zendesk.views.authorize method, it will look something like:

(r'zendesk/$', 'django_zendesk.views.authorize')

Zendesk itself needs a bit of setup, including the URL we just set up above and a log-out URL which already should be implemented somewhere in your site.

Zendesk's documentation for remote authentication is here :

If you're running the tests, make sure to set the TEST_DATABASE_CHARSET setting so that test databases are created to be utf8 compatible.

CREDIT:

Initial idea by Jon Gales with improvements by Alexander Ljungberg.

See initial idea/blog post [here][intial_idea] and here

Build Process:

  1. Update the __version_info__ inside of the application. Commit and push.
  2. Tag the release with the version. git tag <version> -m "Release"; git push --tags
  3. Build the release rm -rf dist build *egg-info; python setup.py sdist bdist_wheel
  4. Upload the data twine upload dist/*

Say Thanks!

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

pivotal_django_zendesk-1.2.0.tar.gz (10.6 kB view details)

Uploaded Source

File details

Details for the file pivotal_django_zendesk-1.2.0.tar.gz.

File metadata

  • Download URL: pivotal_django_zendesk-1.2.0.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.1

File hashes

Hashes for pivotal_django_zendesk-1.2.0.tar.gz
Algorithm Hash digest
SHA256 218f82a188bcc96e9f5bb908f36e5888bb225859f440fe2681c1d3f708a8fa8a
MD5 9629779b3bd615a444a3851551b9596e
BLAKE2b-256 d5a63e5f79b1b201a84defdf249f43f7d84a5807212ec1eeefcfc74a035db01b

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