{ "info": { "author": "Victor Neo", "author_email": "icyisamu@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4" ], "description": "=============================\nDjango-Helpscout\n=============================\n\n.. image:: https://travis-ci.org/victorneo/Django-Helpscout.svg?branch=master\n :target: https://travis-ci.org/victorneo/Django-Helpscout\n\n.. image:: https://img.shields.io/coveralls/victorneo/Django-Helpscout.svg\n :target: https://coveralls.io/r/victorneo/Django-Helpscout?branch=master \n\nHelp Scout integration for Django.\n\nIntroduction\n-------------\n\nIf you are using Help Scout to handle support tickets for your Django\nweb application, you can use Help Scout's custom app feature to provide\nadditional information on the user, such as the following:\n\n.. image:: https://raw.githubusercontent.com/victorneo/Django-Helpscout/master/helpscout_customapp.png\n\nThis project provides a Django app which allows you to integrate Help Scout\nCustom App into your Django web application and easily customize the output.\n\nInstallation\n-------------\n\nYou can install this library via ``pip``::\n\n pip install django-helpscout\n\nOnce installed, add ``django_helpscout`` to your ``INSTALLED_APPS``::\n\n INSTALLED_APPS = (\n ...,\n 'django_helpscout'\n ...,\n )\n\nAdd Help Scout's secret key to your settings file::\n\n HELPSCOUT_SECRET = ''\n\n\nGetting Started\n----------------\n\nA Django view is provided to make it easy for you to get started. First, add\nthe view to your ``urls.py``::\n\n from django_helpscout.views import helpscout_user\n\n urlpatterns = patterns('',\n # Your URL definitions\n url(r'^helpscout-user/$', helpscout_user),\n )\n\nOnce done, deploy your web application to production and point your\nHelp Scout Custom App URL to the url you have configured above and\nyou should see a simple HTML output on the side bar of a support ticket with\nthe user's username and join date.\n\nCustomizing the HTML Output\n---------------------------\n\nYou will want to customize the HTML output to add in additional information\nrelated to the user. You can do so by overriding the templates that are\nincluded.\n\nIn your templates folder, create the following structure::\n\n templates/\n |- django_helpscout\n |- 404.html\n |- helpscout.html\n\nDetails on the two templates:\n\n``404.html``\n Used when a user with the given email address is not found\n\n``helpscout.html``\n Used when a user is found\n\nBy overriding the library's built-in templates, you can customize the output to\nsuit your needs.\n\nFurther Customizations\n----------------------\n\nYou might want to use ``select_related`` to prefetch related models\nfor a particular user, or you have additional data sources to query\nwhen loading a user. A helper decorator is available if you wish to\nuse your own view.\n\nThe decorator helps you deal with verifying Help Scout's signature\nwhen a request is made from their side. You can use the decorator\nin the following manner::\n\n from django_helpscout.helpers import helpscout_request\n\n # your view\n @helpscout_request\n def load_user_for_helpscout(request):\n ... code here ...\n\n\nLicense\n-------\n\nCopyright 2014 Victor Neo\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n\n\nHistory\n-------\n\n0.6.3 (2015-05-21)\n++++++++++++++++++\n\n* Added csrf_exempt decorator to helpscout_user view.\n* Fixed failing bytes conversion on Python < 3 in helpscout_request decorator.\n\n0.6.2 (2014-12-04)\n++++++++++++++++++\n\n* Updated documentation with previously missing configuration option.\n\n0.6.1 (2014-11-20)\n++++++++++++++++++\n\n* Fixed bug with Django's HTTP header names (Thanks @Fizzadar!)\n\n0.6.0 (2014-09-29)\n++++++++++++++++++\n\n* Preliminary Python 3.4 support.\n\n0.5.0 (2014-08-06)\n++++++++++++++++++\n\n* PyPI release.\n\n0.0.1 (2014-08-01)\n++++++++++++++++++\n\n* Initial release on GitHub.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/victorneo/Django-Helpscout", "keywords": "Django-Helpscout,Django,Help Scout", "license": "Apache License V2", "maintainer": null, "maintainer_email": null, "name": "django-helpscout", "package_url": "https://pypi.org/project/django-helpscout/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-helpscout/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/victorneo/Django-Helpscout" }, "release_url": "https://pypi.org/project/django-helpscout/0.6.3/", "requires_dist": null, "requires_python": null, "summary": "Help Scout integration for Django", "version": "0.6.3" }, "last_serial": 1568789, "releases": { "0.5.0": [], "0.6.1": [ { "comment_text": "", "digests": { "md5": "31bd7cdb4dd3adab8f49fa05999e3a05", "sha256": "a17a1c0a30da389809a5ce6c2f78579a02ad00b96a97d7c9c4f26f7c74cf592f" }, "downloads": -1, "filename": "django-helpscout-0.6.1.tar.gz", "has_sig": false, "md5_digest": "31bd7cdb4dd3adab8f49fa05999e3a05", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6297, "upload_time": "2014-11-19T19:09:29", "url": "https://files.pythonhosted.org/packages/75/8e/20aa83626bf528883012f9b8ae47e7d2d860ef2abe409dd8c008cca9aa7c/django-helpscout-0.6.1.tar.gz" } ], "0.6.2": [ { "comment_text": "", "digests": { "md5": "f17968364f9b68559187116bbcd21307", "sha256": "a0fa66e3acbe8e21db4a89d783051ea519a57b2f989b4e68058aa67195033dc7" }, "downloads": -1, "filename": "django-helpscout-0.6.2.tar.gz", "has_sig": false, "md5_digest": "f17968364f9b68559187116bbcd21307", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6516, "upload_time": "2014-12-03T16:57:52", "url": "https://files.pythonhosted.org/packages/dd/e9/1afc6fc181e523c632ede3429e1b206a14dcbdb617e045396bd04de168b1/django-helpscout-0.6.2.tar.gz" } ], "0.6.3": [ { "comment_text": "", "digests": { "md5": "8ff82567c7b8622141498d336f190d5c", "sha256": "142720188d269e021314c53348c9ac814638f4e06dae994bd15c01972050dbaf" }, "downloads": -1, "filename": "django-helpscout-0.6.3.tar.gz", "has_sig": false, "md5_digest": "8ff82567c7b8622141498d336f190d5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6626, "upload_time": "2015-05-30T07:10:15", "url": "https://files.pythonhosted.org/packages/7c/0f/5e50dd6221931d569e86d9c3a597934933a96727e9520ab091dc4b68dea8/django-helpscout-0.6.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8ff82567c7b8622141498d336f190d5c", "sha256": "142720188d269e021314c53348c9ac814638f4e06dae994bd15c01972050dbaf" }, "downloads": -1, "filename": "django-helpscout-0.6.3.tar.gz", "has_sig": false, "md5_digest": "8ff82567c7b8622141498d336f190d5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6626, "upload_time": "2015-05-30T07:10:15", "url": "https://files.pythonhosted.org/packages/7c/0f/5e50dd6221931d569e86d9c3a597934933a96727e9520ab091dc4b68dea8/django-helpscout-0.6.3.tar.gz" } ] }