https://github.com/bensteuem/communiapi
Python package to implement REST functions communiapp.de
https://github.com/bensteuem/communiapi
Last synced: over 1 year ago
JSON representation
Python package to implement REST functions communiapp.de
- Host: GitHub
- URL: https://github.com/bensteuem/communiapi
- Owner: bensteUEM
- Created: 2023-01-07T16:02:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-13T17:21:39.000Z (over 1 year ago)
- Last Synced: 2025-01-23T01:33:46.663Z (over 1 year ago)
- Language: Python
- Size: 47.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Setup
CommuniApi class requires params for your Communi configuration.
## Initial configuration
This package requires the ChurchToolsApi to be installed.
If you setup this package using pip it should be a required dependency.
If you only downloaded this code without package management you will need to install it to your python environment
Check https://github.com/bensteUEM/ChurchToolsAPI/releases for the latest realease.
Config Params required by ChurchTools might be required too - check respective documentation!
### How to use with config.py
By default some changes need to be made to config.py before first use.
(if you want to use it as config params)
1 Get your REST access token from your instance
e.g. https://YOURINSTANCE.communiapp.de/page/integration/tab/rest
and save it in the configuration file.
```
token = 'ENTER-YOUR-TOKEN-HERE'
```
All requests are executed against the central REST server of communi which is part of the default config
This part does likely not need any change unless you have a special configuration.
```
rest_server = 'https://api.communiapp.de/rest'
```
In order to addres your own instance (matching to the token) you need to change the communiApp in the config
Please 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.
```
communiApp = 0
```
In addition the login details for a ChurchTools instance is required for CT specific access
```
ct_domain = 'https://XXX'
ct_token = ###
```
ct_users = {'username': 'test'}
# Usage
The script is maintained using VS Studio Code.
Test cases are run against my own instance - please adapt to yours before changing any code and make sure they run successfully!
Be aware that some of the test cases require specific IDs to be present on your instance.
The respective function do have a hint like the one below in the docstring of the respective functions
```
IMPORTANT - This test method and the parameters used depend on the target system!
```
# Recurring use cases
To simplify recurring use cases all required steps are documented in a Jupyter Notebook.
Check main.ipynb - at present it creates a connection and deletes old event chats while new ones are created
## Compatibility
Tested against the current CommuniAPIs as of October 2023.
More information is provided on the respective Communi pages.
# License
This code is provided with a CC-BY-SA license
See https://creativecommons.org/licenses/by-sa/2.0/ for details.
In short this means - feel free to do anything with it
BUT you are required to publish any changes or additional functionality (even if you intended to add functionality for
yourself only!)
Anybody using this code is more than welcome to contribute with change requests to the original repository.
## Contributors
benste - implemented for use at Evangelische Kirchengemeinde Baiersbronn (https://www.evang-kirche-baiersbronn.de/)