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.

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.0.3.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pivotal_django_zendesk-1.0.3-py2.py3-none-any.whl (8.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for pivotal_django_zendesk-1.0.3.tar.gz
Algorithm Hash digest
SHA256 e04d84d08f7697f26c82f5b598359a1b2b75f4afe355ed9818183eb8f4acdde4
MD5 dd50a18ba86331faaaaeae13a1b89f9b
BLAKE2b-256 7ceb0f2d2106e31d95c4ca2c4057f234a6c907e1f58c55ff00d0f29f64827082

See more details on using hashes here.

File details

Details for the file pivotal_django_zendesk-1.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pivotal_django_zendesk-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 63e4e1e6e96bd9d7dbe32b8b0f2b3e603926d7cc03755e80f284c7c37be2d998
MD5 68670e92199bf25db6e13feabc983143
BLAKE2b-256 29708566763907e87214e1696394d12e06e646abae99bb9d81d525db1666a915

See more details on using hashes here.

Supported by

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