django-helpscout 0.6.3

简介

如果您使用帮助球探为您的django处理支持票 web应用程序，您可以使用help scout的自定义应用程序功能来提供 有关用户的其他信息，如以下信息：

此项目提供了一个django应用程序，允许您集成help scout 将自定义应用程序放入Django Web应用程序中并轻松自定义输出。

安装

您可以通过pip：

pip install django-helpscout

安装后，将django_helpscout添加到INSTALLED_APPS：

INSTALLED_APPS = (
    ...,
    'django_helpscout'
    ...,
)

将帮助童军的密钥添加到您的设置文件：

HELPSCOUT_SECRET = '<helpscout custom app secret key>'

开始

提供了django视图，使您可以轻松开始。首先，添加 查看您的urls.py：

from django_helpscout.views import helpscout_user

urlpatterns = patterns('',
    # Your URL definitions
    url(r'^helpscout-user/$', helpscout_user),
)

完成后，将Web应用程序部署到生产环境中，并指向 帮助Scout自定义应用程序的URL指向您在上面配置的URL 您应该在支持票证的侧栏上看到一个简单的html输出 用户的用户名和加入日期。

自定义HTML输出

您需要自定义HTML输出以添加其他信息 与用户相关。可以通过重写 包括。

在“模板”文件夹中，创建以下结构：

templates/
    |- django_helpscout
             |- 404.html
             |- helpscout.html

两个模板的详细信息：

404.html

当找不到具有给定电子邮件地址的用户时使用

helpscout.html

在找到用户时使用

通过重写库的内置模板，可以将输出自定义为 适合你的需要。

进一步定制

您可能希望使用select_related预取相关模型 对于特定用户，或者您有其他数据源要查询 加载用户时。如果您愿意，可以使用一个助手装饰器 用你自己的观点。

decorator帮助您验证help scout的签名 当他们提出请求时。你可以用这个装饰器 以如下方式：

from django_helpscout.helpers import helpscout_request

# your view
@helpscout_request
def load_user_for_helpscout(request):
    ... code here ...

许可证

版权所有2014 Victor Neo

根据apache许可证2.0版（以下简称“许可证”）授权； 除非符合许可证，否则您不能使用此文件。 您可以在

http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则软件 根据许可证分发是按“原样”分发的， 无任何明示或默示的保证或条件。 有关管理权限的特定语言和 许可下的限制。

历史记录