用于cms目录的python api客户端。
directory-cms-client的Python项目详细描述
目录cms client
目录CMS客户端。
目录内容管理只读API的客户端。
安装
$ pip install directory-cms-client
API客户端需要以下设置:
Setting | Notes |
---|---|
DIRECTORY_CMS_API_CLIENT_BASE_URL | |
DIRECTORY_CMS_API_CLIENT_API_KEY | Unique to client. Retrieved during the on-boarding process. |
DIRECTORY_CMS_API_CLIENT_SENDER_ID | Unique to client. Retrieved during the on-boarding process. |
DIRECTORY_CMS_API_CLIENT_DEFAULT_TIMEOUT | |
DIRECTORY_CMS_API_CLIENT_SERVICE_NAME | Unique to client, can be hardcoded. |
以下directory client core settings也适用于目录cms客户端:
Setting | Notes |
---|---|
DIRECTORY_CLIENT_CORE_CACHE_EXPIRE_SECONDS | Duration to store the retrieved content in the cache. |
DIRECTORY_CLIENT_CORE_CACHE_LOG_THROTTLING_SECONDS | Duration to throttle log events for a given url for. |
并指定一个名为cms_fallback
:
CACHES = {
'cms_fallback': ...
}
完成后,可以使用api客户端:
fromdirectory_api_client.clientimportcms_api_client
开发
$ git clone https://github.com/uktrade/directory-cms-client $ cd directory-cms-client $ [create virtual environment and activate] $ make test_requirements
发布到pypi
包应该在合并到主服务器时发布到pypi。如果您需要在本地执行此操作,请从rattic获取凭据并将环境变量添加到主机:
Setting |
---|
DIRECTORY_PYPI_USERNAME |
DIRECTORY_PYPI_PASSWORD |
然后运行以下命令:
$ make publish