ChurchToolsAPI
Version 1.7.0
默认下载项目源码，需要在“secure”文件夹中添加一个config.py，默认执行。请注意，这将包含敏感信息，切勿与第三方共享，因此包含在 gitignore 中
它应该看起来像这样：
# COMMENT FOR WHICH USER / DATE this is -> DO NOT SHARE
ct_domain = 'https://YOUR-DOMAIN.DE'
ct_token = 'TOKEN SECRET VERY LONG RANDOM STRING'
ct_users = {'USER_EMAIL': 'USER_PASSWORD'}
如果你想将此代码用作 python 模块，某些类将需要类似于配置文件的参数才能访问你的系统
最新版本可以在 https://github.com/bensteUEM/ChurchToolsAPI/releases 上找到
可以使用pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api'将 XXX 替换为已发布的版本号来安装
CT_TOKEN 可以使用用户的“Berechtigungen”选项来获取/更改，该选项应用于访问 CT 实例。强烈建议设置一个具有最小权限的自定义用户来使用此模块。但是，如果用户缺少权限，请检查日志文件并预期结果不完整。
该脚本最后是使用 VS Code 更新的。测试用例（例如来自 test_ChurchToolsApi.py）在推送到 GitHub 时会自动运行。这可确保至少针对一种环境检查基本功能。 Github Repo 针对所有者的生产实例进行测试，以确保测试数据匹配。
请注意，某些测试用例需要在进行测试的 CT 服务器上存在特定 ID。相应函数在相应函数的文档字符串中确实有如下所示的提示
IMPORTANT - This test method and the parameters used depend on the target system!
非常欢迎您使用各自的功能分支和拉取请求贡献额外的代码。新功能应始终包含各自的测试用例（可以根据合并请求调整到自动化测试系统）+
还有一个 main.ipynb 可用于快速执行单个操作，而无需编写单独的 python 项目
针对截至 2024 年 9 月的当前 Churchtools API (CT 3.101) 进行了测试。更多信息请参见相应的 ChurchTools 页面。
https://YOUR_DOMAIN/api/
最近的访问方法 - 应用于可通过此 API 访问的任何内容。打开相应的 URL 可以找到其他端点的文档。该模块的开发是为了支持所有贡献者的特定用例 - 某些端点可能尚未实现！
https://api.church.tools/index.html
WebUI 使用的旧版 API，其中包括一些尚未在 REST API 中实现的端点。可以使用 Web 开发人员控制台对某些功能进行逆向工程以监控请求。该 API 可能会发生变化，并且可能会停止与任何未来版本一起使用！
它也比 REST api 更耗时，因为它经常查询大量数据而不是特定项目。
此代码附带 CC-BY-SA 许可证，请参阅 https://creativecommons.org/licenses/by-sa/2.0/ 了解详细信息。
简而言之，这意味着 - 可以随意使用它做任何事情，但您需要发布任何更改或附加功能（即使您只想为自己添加功能！）
我们非常欢迎任何使用此代码的人向原始存储库提出更改请求。
