/django-freshdesk-sso

Django Freshdesk SSO enables SSO for freshdesk from your django application.

Primary LanguagePythonMIT LicenseMIT

Django Freshdesk SSO

Django Freshdesk SSO enables SSO for freshdesk from your django application.

This package replaces the stale and out of date django-freshdesk package.

Quick start

  1. Add "freshdesk_sso" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        'freshdesk_sso',
    ]
    
  2. Include the freshdesk SSO URLconf in your project urls.py like this:

    path('accounts/login/sso/', include('freshdesk_sso.urls')),
    
  3. Add the required environment variables to your settings.py file:

    FRESHDESK_URL = 'http://yourcompany.freshdesk.com/'
    FRESHDESK_SECRET_KEY = 'YOUR_SECRET_GOES_HERE'
    

Publishing to PyPi

If you're a maintainer of this package, you'll need poetry to publish to PyPi.

  1. Push your changes to the main branch

  2. Bump the version and commit:

    poetry version the_new_version
    git add pyproject.toml
    git commit -m "Version bump old_version -> new_version"
    
  3. Build and publish:

    poetry build
    poetry publish