ChurchToolsAPI
Version 1.7.0
デフォルトでプロジェクトのソース コードをダウンロードするには、デフォルトで実行するために config.py を「secure」フォルダーに追加する必要があります。これには機密情報が含まれるため、第三者と共有してはいけないため、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 は、CT インスタンスにアクセスするために使用するユーザーの「Berechtigungen」オプションを使用して取得/変更できます。このモジュールで使用するための最小限の権限を持つカスタム ユーザーをセットアップすることを強くお勧めします。ただし、ログ ファイルを確認して、ユーザーが権限を変更している場合は不完全な結果が得られることを想定してください。
スクリプトは最後に VS Code を使用して更新されました。テスト ケース (例: test_ChurchToolsApi.py から) は、GitHub にプッシュされると自動的に実行されます。これにより、基本的な機能が少なくとも 1 つの環境に対してチェックされることが保証されます。 Github リポジトリは、テスト用のデータが一致していることを確認するために、所有者の運用インスタンスに対してテストを行います。
一部のテスト ケースでは、テスト対象の CT サーバー上に特定の ID が存在する必要があることに注意してください。それぞれの関数には、それぞれの関数のドキュメント文字列に以下のようなヒントがあります。
IMPORTANT - This test method and the parameters used depend on the target system!
それぞれの機能ブランチやプル リクエストを使用して追加のコードを提供することは大歓迎です。新しい関数には常にそれぞれのテスト ケースが含まれている必要があります (マージ リクエスト時に自動テスト システムに合わせて調整できます)+
別の Python プロジェクトを作成せずに、単一のアクションを迅速に実行するために使用できる main.ipynb もあります。
2024 年 9 月時点の現在の Churchtools API (CT 3.101) に対してテスト済み。詳細については、それぞれの ChurchTools ページを参照してください。
https://あなたのドメイン/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/ を参照してください。
つまり、これは、自由に何をしても構いませんが、変更や追加機能を公開する必要があります (自分のためだけに機能を追加するつもりだった場合でも)。
このコードを使用している人は誰でも、元のリポジトリへの変更リクエストに貢献することを歓迎します。
