Package: django-helpscout
Help Scout integration for Django.IntroductionIf you are using Help Scout to handle support tickets for your Django
web application, you can use Help Scout’s custom app feature to provide
additional information on the user, such as the following:This project provides a Django app which allows you to integrate Help Scout
Custom App into your Django web application and easily customize the output.InstallationYou can install this library viapip:pip install django-helpscoutOnce installed, adddjango_helpscoutto yourINSTALLED_APPS:INSTALLED_APPS = (
    ...,
    'django_helpscout'
    ...,
)Add Help Scout’s secret key to your settings file:HELPSCOUT_SECRET = '<helpscout custom app secret key>'Getting StartedA Django view is provided to make it easy for you to get started. First, add
the view to yoururls.py:from django_helpscout.views import helpscout_user

urlpatterns = patterns('',
    # Your URL definitions
    url(r'^helpscout-user/$', helpscout_user),
)Once done, deploy your web application to production and point your
Help Scout Custom App URL to the url you have configured above and
you should see a simple HTML output on the side bar of a support ticket with
the user’s username and join date.Customizing the HTML OutputYou will want to customize the HTML output to add in additional information
related to the user. You can do so by overriding the templates that are
included.In your templates folder, create the following structure:templates/
    |- django_helpscout
             |- 404.html
             |- helpscout.htmlDetails on the two templates:404.htmlUsed when a user with the given email address is not foundhelpscout.htmlUsed when a user is foundBy overriding the library’s built-in templates, you can customize the output to
suit your needs.Further CustomizationsYou might want to useselect_relatedto prefetch related models
for a particular user, or you have additional data sources to query
when loading a user. A helper decorator is available if you wish to
use your own view.The decorator helps you deal with verifying Help Scout’s signature
when a request is made from their side. You can use the decorator
in the following manner:from django_helpscout.helpers import helpscout_request

# your view
@helpscout_request
def load_user_for_helpscout(request):
    ... code here ...LicenseCopyright 2014 Victor NeoLicensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.History0.6.3 (2015-05-21)Added csrf_exempt decorator to helpscout_user view.Fixed failing bytes conversion on Python < 3 in helpscout_request decorator.0.6.2 (2014-12-04)Updated documentation with previously missing configuration option.0.6.1 (2014-11-20)Fixed bug with Django’s HTTP header names (Thanks @Fizzadar!)0.6.0 (2014-09-29)Preliminary Python 3.4 support.0.5.0 (2014-08-06)PyPI release.0.0.1 (2014-08-01)Initial release on GitHub.