{"id":24552436,"url":"https://github.com/bensteuem/communiapi","last_synced_at":"2025-03-16T14:13:53.321Z","repository":{"id":77970702,"uuid":"586289469","full_name":"bensteUEM/CommuniAPI","owner":"bensteUEM","description":"Python package to implement REST functions communiapp.de","archived":false,"fork":false,"pushed_at":"2025-01-13T17:21:39.000Z","size":49,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-23T01:33:46.663Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":"2023-01-07T16:02:51.000Z","updated_at":"2025-01-13T17:21:31.000Z","dependencies_parsed_at":"2023-10-03T18:26:29.139Z","dependency_job_id":"6669797a-2cb2-4e36-a4d7-b19d01a6f149","html_url":"https://github.com/bensteUEM/CommuniAPI","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FCommuniAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FCommuniAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FCommuniAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bensteUEM%2FCommuniAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bensteUEM","download_url":"https://codeload.github.com/bensteUEM/CommuniAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243878491,"owners_count":20362433,"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":[],"created_at":"2025-01-23T01:31:36.649Z","updated_at":"2025-03-16T14:13:53.301Z","avatar_url":"https://github.com/bensteUEM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup\n\nCommuniApi class requires params for your Communi configuration.\n\n## Initial configuration\nThis package requires the ChurchToolsApi to be installed.\nIf you setup this package using pip it should be a required dependency.\nIf you only downloaded this code without package management you will need to install it to your python environment\n\nCheck https://github.com/bensteUEM/ChurchToolsAPI/releases for the latest realease.\n\nConfig Params required by ChurchTools might be required too - check respective documentation!\n\n### How to use with config.py\nBy default some changes need to be made to config.py before first use.\n(if you want to use it as config params)\n\n1 Get your REST access token from your instance\ne.g. https://YOURINSTANCE.communiapp.de/page/integration/tab/rest\nand save it in the configuration file.\n```\ntoken = 'ENTER-YOUR-TOKEN-HERE'\n```\nAll requests are executed against the central REST server of communi which is part of the default config\nThis part does likely not need any change unless you have a special configuration.\n```\nrest_server = 'https://api.communiapp.de/rest'\n```\nIn order to addres your own instance (matching to the token) you need to change the communiApp in the config\nPlease note that the AppID is NOT the same as the primary group ID. As this is undocumented please consult with Communi to retrieve your ID or reverse engineer using a web-client.\n```\ncommuniApp = 0\n```\n\nIn addition the login details for a ChurchTools instance is required for CT specific access\n```\nct_domain = 'https://XXX'\nct_token = ###\n```\n\nct_users = {'username': 'test'}\n\n# Usage\n\nThe script is maintained using VS Studio Code.\nTest cases are run against my own instance - please adapt to yours before changing any code and make sure they run successfully!\nBe aware that some of the test cases require specific IDs to be present on your instance.\nThe respective function do have a hint like the one below in the docstring of the respective functions\n```\nIMPORTANT - This test method and the parameters used depend on the target system!\n```\n\n# Recurring use cases\nTo simplify recurring use cases all required steps are documented in a Jupyter Notebook.\nCheck main.ipynb - at present it creates a connection and deletes old event chats while new ones are created\n\n## Compatibility\n\nTested against the current CommuniAPIs as of October 2023.\nMore information is provided on the respective Communi pages.\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 \nbenste - implemented for use at Evangelische Kirchengemeinde Baiersbronn (https://www.evang-kirche-baiersbronn.de/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbensteuem%2Fcommuniapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbensteuem%2Fcommuniapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbensteuem%2Fcommuniapi/lists"}