Django视图和表单,用于提交Zendesk工单
项目描述
一个可扩展的库,用于向Zendesk提交票据的Django视图表单。
使用方法
将这些添加到您的settings.py
ZENDESK_BASE_URL = 'https://example.zendesk.com'
ZENDESK_API_USERNAME = ...
ZENDESK_API_TOKEN = ...
ZENDESK_REQUESTER_ID = ...
ZENDESK_GROUP_ID = ...
在您的urls.py中添加一个条目
from zendesk_tickets.views import TicketView
path(r'submit-ticket/$', TicketView.as_view(
success_url='/',
template_name='app_name/submit-ticket-page.html',
ticket_subject='Website Feedback',
ticket_tags=['website', 'feedback']
ticket_template_name='app_name/feedback-ticket.txt',
), name='submit_ticket'),
如果您想包括额外的字段,则从BaseTicketForm派生子类并添加它们。如果您想将它们包含在票据正文中,创建一个新的票据模板并将其作为ticket_template_name传递。如果您想将它们作为自定义字段包含,请在您的settings.py中定义以下内容
ZENDESK_CUSTOM_FIELDS = {
'referer': 31, # zendesk field id
'username': 32,
'user_agent': 33,
}
上面示例中的三个字段默认包含在TicketForm中,并且可以通过在票据模板中引用它们或在设置中指定自定义字段ID来包含在票据中。
开发
请将错误报告和拉取请求提交到GitHub。
要修改此库,建议在虚拟环境中以可编辑模式安装它,即 pip install --editable .
使用 python -m tests 在本地运行所有测试。如果您有多个Python版本,则可以使用 tox。
当任何可本地化的字符串更改时,使用 python scripts/messages.py update 更新翻译文件。使用 python scripts/messages.py compile 编译它们;在测试和分发之前,这是必需的。更新和编译翻译文件需要安装gettext系统包。
[仅限GitHub团队成员] 通过以下方式将新版本分发到 PyPI
更新zendesk_tickets/__init__.py中的VERSION元组
在历史中添加注释
在GitHub上发布一个版本,这将触发上传到PyPI;或者,在本地运行python scripts/messages.py compile; python -m build; twine upload dist/*
历史
- 0.18
添加对Django版本5.0 & 5.1的实验性支持。
- 0.17
将测试、构建和发布过程从弃用的setuptools命令迁移到其他方法。更新并编译翻译文件的脚本不包括在分发中。库没有重大更改。
- 0.16
停止支持python 3.6和3.7。添加对python 3.11的支持。添加对Django版本4.0 & 4.1的实验性支持。改进测试和代码检查。
- 0.15
添加对python 3.9和3.10的支持。改进测试和代码检查。
- 0.14
停止支持python 3.5。改进代码检查。
- 0.13
停止python 2支持(现在与3.5 - 3.8兼容)。支持Django 2.2 - 3.2(均为LTS)。
- 0.12
改进测试和代码检查。
- 0.11
支持Django 1.10 - 2.0。添加基于类的Django视图。添加国际化支持。
- 0.10
修复在Zendesk中显示票据的问题。
- 0.9
不允许使用自引用的返回URL。
- 0.8
接受在视图中使用额外的模板上下文。
- 0.7
如果可用,则使用登录用户的电子邮件地址。
- 0.6
可选地收集表单提交者的电子邮件地址。
- 0.5
修复错误。
- 0.4
提供一个安全的“返回上一页”链接。
- 0.3
添加成功视图。
- 0.2
修复错误。
- 0.1
原始发布。
版权
版权(C)2023 HM Government(司法部数字与技术)。有关详细信息,请参阅LICENSE.txt。
项目详情
下载文件
下载适合您平台的应用程序。如果您不确定该选择哪一个,请了解有关安装包的更多信息。