{"id":24552450,"url":"https://github.com/bensteuem/churchtoolsapi","last_synced_at":"2026-01-21T21:10:05.255Z","repository":{"id":65372641,"uuid":"565929712","full_name":"bensteUEM/ChurchToolsAPI","owner":"bensteUEM","description":"Collection of Python files to use the API for ChurchTools","archived":false,"fork":false,"pushed_at":"2025-03-09T15:31:56.000Z","size":375,"stargazers_count":7,"open_issues_count":23,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T23:13:20.590Z","etag":null,"topics":["ajax","churchtools","churchtools-api","churchtools-client","python","rest","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bensteUEM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-14T16:11:54.000Z","updated_at":"2025-03-09T15:31:26.000Z","dependencies_parsed_at":"2025-01-23T01:31:46.953Z","dependency_job_id":"0320c24d-afc1-4753-9a19-5faac3f101f4","html_url":"https://github.com/bensteUEM/ChurchToolsAPI","commit_stats":null,"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FChurchToolsAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FChurchToolsAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FChurchToolsAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FChurchToolsAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bensteUEM","download_url":"https://codeload.github.com/bensteUEM/ChurchToolsAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249167448,"owners_count":21223506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ajax","churchtools","churchtools-api","churchtools-client","python","rest","rest-api"],"created_at":"2025-01-23T01:31:38.814Z","updated_at":"2026-01-21T21:10:05.188Z","avatar_url":"https://github.com/bensteUEM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup\n\n## Using project source code directly\n\nDownloading the source code of the project by default a config.py\nneeds to be added in the \"secure\" folder for default execution.\nPlease be aware that this will include sensitive information and should never be shared with 3rd parties and is\ntherefore included in gitignore\n\nIt should look like this:\n\n```\n# COMMENT FOR WHICH USER / DATE this is -\u003e DO NOT SHARE\nct_domain = 'https://YOUR-DOMAIN.DE'\nct_token = 'TOKEN SECRET VERY LONG RANDOM STRING'\nct_users = {'USER_EMAIL': 'USER_PASSWORD'}\n```\n\n## Using it as a module\n\nIf you want to use this code as a python module certain classes will require params similar to the config file in order\nto access your system\n\n- check the docstrings for correct usage\n\nThe latest release can be found on https://github.com/bensteUEM/ChurchToolsAPI/releases\n\nIt can be installed using\n```pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@vX.X.X#egg=churchtools-api'```\nreplacing X.X.X by a released version number\n\n### CT Token\n\nCT_TOKEN can be obtained / changed using the \"Berechtigungen\" option of the user which should be used to access the CT\ninstance. It is highly recommended to setup a custom user with minimal permissions for use with this module.\nHowever please check the log files and expect incomplete results if the user is msising permissions.\n\n# Development use\n\nThe script was last updated using VS Code. \nTest cases (e.g. from test_ChurchToolsApi.py) are automatically run when pushed to GitHub. This ensures that basic functionality is checked against at least one environment.\nThe Github Repo tests against against the owners production instance in order to ensure matching data for tests.\n\nPlease be aware that some of the test cases require specific IDs to be present on the CT server which is tested against.\nThe respective function do have a hint like the one below in the docstring of the respective functions\n\n```\nIMPORTANT - This test method and the parameters used depend on the target system!\n```\n\nYou are more than welcome to contribute additional code using respective feature branches and pull requests. New functions should always include respective test cases (that can be adjusted to the automated test system upon merge request)+\n\nThere is also a main.ipynb which can be used to quickly execute single actions without writing a seperate python project\n\n## Compatibility\n\nTested against the current Churchtools APIs as of Sept 2024 (CT 3.101). More information is provided on the respective ChurchTools pages.\n\n### REST API\n\nhttps://YOUR_DOMAIN/api/\n\nMost recent access method - should be used for anything that is accessible through this API.\nDocumentation of additional endpoints can be found opening the respective URL.\nThe module was developed to support the specific use-cases by all contributors - some endpoints might not be implemented yet!\n\n### Legacy API\n\nhttps://api.church.tools/index.html\n\nLegacy API used by the WebUI which includes some endpoints that were not yet implemented into the REST API.\nSome functions can be reverse engineered using Web-Developer Console to monitor requests.\nThe API is subject to change and might stop working with any future release!\n\nIt is also more time consuming than the REST api as it often queries large sets of data instead of specific items.\n\n# License\n\nThis code is provided with a CC-BY-SA license\nSee https://creativecommons.org/licenses/by-sa/2.0/ for details.\n\nIn short this means - feel free to do anything with it\nBUT you are required to publish any changes or additional functionality (even if you intended to add functionality for\nyourself only!)\n\nAnybody using this code is more than welcome to contribute with change requests to the original repository.\n\n## Contributors\n\n* benste - implemented for use at Evangelische Kirchengemeinde Baiersbronn (https://www.evang-kirche-baiersbronn.de/)\n* kolibri52 - Jonathan supporting Liebenzeller Gemeinschaft Oettingen (https://lgv-oe.de/)\n* fschrempf - Frieder supporting CVJM Esslingen e. V. (https://cvjm-esslingen.de)\n* wengc3 - https://github.com/wengc3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbensteuem%2Fchurchtoolsapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbensteuem%2Fchurchtoolsapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbensteuem%2Fchurchtoolsapi/lists"}