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/ 以了解詳細資訊。
簡而言之，這意味著 - 可以隨意使用它做任何事情，但您需要發布任何更改或附加功能（即使您只想為自己添加功能！）
我們非常歡迎任何使用此程式碼的人向原始儲存庫提出更改請求。
