用于同步Zendesk环境的命令行工具
zdsync的Python项目详细描述
zdsync是用于同步zendesk环境的命令行实用程序。
依赖关系
- Python3.5+
- ^{
}
用法
如果您使用python setup.py install
或通过pip进行安装,则应该将名为zdsync
的程序放入pythonhome中。否则,您可以使用PYTHONPATH=. python -m zdsync.cli
获得相同的效果。
有两个必需的环境变量,
SANDBOX_SUBDOMAIN
-沙盒环境的子域,例如mycompany1552085434
。PRODUCTION_SUBDOMAIN
-生产环境的子域,例如mycompany
。
有三种方法可以对ZendeskAPI进行身份验证,根据您首选的身份验证方法,需要不同的环境变量。
- 电子邮件和密码
SANDBOX_EMAIL
-登录沙盒环境时用作用户名的电子邮件。SANDBOX_PASSWORD
-登录沙盒环境时使用的密码。PRODUCTION_EMAIL
-登录到生产环境时用作用户名的电子邮件。PRODUCTION_PASSWORD
-登录到生产环境时使用的密码。
- 电子邮件和API令牌
SANDBOX_EMAIL
-登录沙盒环境时用作用户名的电子邮件。SANDBOX_TOKEN
-沙盒环境的api令牌。PRODUCTION_EMAIL
-登录到生产环境时用作用户名的电子邮件。PRODUCITON_TOKEN
-生产环境的api令牌。
- OAuth令牌
SANDBOX_OAUTH_TOKEN
-对沙盒环境具有read/write访问权限的oauth令牌。PRODUCTION_OAUTH_TOKEN
-对生产环境具有只读访问权限的oauth令牌。
有五个支持同步的对象,
--brands
--groups
--ticket-fields
--ticket-forms
--macros
建议按此顺序进行同步,因为在处理列表时存在对象依赖项。如果传递--all
标志,它将按此顺序同步。
只要传递一个对象标志或--all
就会打印出环境的状态,
$ zdsync --macros
The following Macros only exist in the sandbox:
The following Macros only exist in production:
The following Macros are different between environments:
Customer not responding Downgrade and inform Close and redirect to topics Take it!
There are 257 other Macros that are the same between environments.
为了实际执行同步,必须传递--execute
标志,
$ zdsync --macros --execute
许可证
此工具在isc许可下获得许可,其文本可在LICENSE.txt获得。