ChurchToolsAPI
Version 1.7.0
기본적으로 프로젝트의 소스 코드를 다운로드하려면 기본 실행을 위해 "secure" 폴더에 config.py를 추가해야 합니다. 여기에는 민감한 정보가 포함되어 있으므로 제3자와 공유해서는 안 되므로 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" 옵션을 사용하여 획득/변경할 수 있습니다. 이 모듈과 함께 사용하려면 최소한의 권한으로 사용자 정의 사용자를 설정하는 것이 좋습니다. 그러나 사용자가 권한을 msising하는 경우 로그 파일을 확인하고 불완전한 결과를 예상하십시오.
스크립트는 VS Code를 사용하여 마지막으로 업데이트되었습니다. 테스트 사례(예: test_ChurchToolsApi.py)는 GitHub에 푸시되면 자동으로 실행됩니다. 이렇게 하면 최소한 하나의 환경에 대해 기본 기능을 확인할 수 있습니다. Github Repo는 테스트용 데이터 일치를 보장하기 위해 소유자 프로덕션 인스턴스에 대해 테스트합니다.
일부 테스트 사례에서는 테스트 대상인 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://YOUR_DOMAIN/api/
최신 액세스 방법 - 이 API를 통해 액세스할 수 있는 모든 항목에 사용해야 합니다. 추가 엔드포인트에 대한 문서는 해당 URL을 열면 찾을 수 있습니다. 이 모듈은 모든 기여자의 특정 사용 사례를 지원하기 위해 개발되었습니다. 일부 엔드포인트는 아직 구현되지 않았을 수 있습니다!
https://api.church.tools/index.html
REST API에 아직 구현되지 않은 일부 엔드포인트를 포함하는 WebUI에서 사용되는 레거시 API입니다. 일부 기능은 웹 개발자 콘솔을 사용하여 리버스 엔지니어링하여 요청을 모니터링할 수 있습니다. API는 변경될 수 있으며 향후 릴리스에서는 작동이 중단될 수 있습니다!
또한 특정 항목 대신 대규모 데이터 세트를 쿼리하는 경우가 많기 때문에 REST API보다 시간이 더 많이 소요됩니다.
이 코드는 CC-BY-SA 라이선스와 함께 제공됩니다. 자세한 내용은 https://creativecommons.org/licenses/by-sa/2.0/을 참조하세요.
간단히 말해서 이는 무엇이든 자유롭게 수행할 수 있지만 변경 사항이나 추가 기능을 게시해야 함을 의미합니다(자신만을 위한 기능을 추가하려는 경우에도 마찬가지입니다!).
이 코드를 사용하는 사람이라면 누구나 원래 저장소에 대한 변경 요청에 기여하는 것을 환영합니다.
