v2.0.0

2.0.0 (2025-05-20)

⚠ BREAKING CHANGES

• events: removed legacy test (#148)
• events: implemented update_event and replaced event admin tests respectively (#150)
• songs: removed legacy get_song_ajax (#151)
• tags: migrated tags to new API (#49; #142)
• songs: updated use of create edit and delete with REST api incl. arrangements (#143,#144)
• tags: updated tags API and usage (#142)

Features

• api: Add a function to retrieve base url (4082696)
• events: implemented update_event and replaced event admin tests respectively (#150) (fe788d9)
• events: removed legacy test (#148) (74d21e4)
• groups: implement get_groups params passthrough and pre-test cleanup (1de0b28)
• misc: introduced ratelimited api requests (#37) (4ccc96b)
• songs: implement set_default_arrangement and fix sourceReference and sourceName (#144) (#272) (10c5d19)
• songs: moved delete_song_arrangement from AJAX to REST (#152) (db696c9)
• songs: removed legacy get_song_ajax (#151) (4541e16)
• songs: updated use of create edit and delete with REST api incl. arrangements (#143,#144) (fad91ee)
• tags: migrated tags to new API (#49; #142) (e431a08)
• tags: updated tags API and usage (#142) (af2b606)

Bug Fixes

• calendar: implemented workaround for API changes (#141) (701e443)
• calendar: removed workaround because bug is feature (trunkcate seconds) #141 (9b42ea0)
• events: test_get_set_event_services_counts (#140) (94f144b)
• files: sample key references (#140) (af8a472)
• groups: updated to more recent API behaviour (#140) (8ac3f9e)
• misc: increased number of attempts for ratelimited session because of github action speed (#37) (9783061)
• posts: updated tests and changed pagination (#145) (e7788cd)
• repeat requests after timeout with too_many_requests (#37) (ecd58c3)
• resources: updated resource keys in test (#146) (a1c5c5d)
• songs: corrected dtypes (#144) (10c5d19)

Install as package using:

pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@v2.0.0#egg=churchtools-api

Full Changelog: v1.8.0...v2.0.0

v1.8.0

1.8.0 (2025-05-17)

Features

• implemented release automation (#154) (5496625)

Install as package using:

pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@v1.8.0#egg=churchtools-api

Full Changelog: 1.7.3...v1.8.0

1.7.3

Minor release with 3 small updates / additions

• #135 simplified logging messages
• #136 improved timezone handling with events
• #139 group member fields - thanks to @wengc3

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.7.3#egg=churchtools-api

Full Changelog: 1.7.0...1.7.3

1.7.0

Added

• /tags #93
• /posts #128
• /resource/masterdata #114 #124
  -> WARNING - if used before type Param is now renamed resultClass - breaking change detected after publication...
• song sources #119
• create, update and delete calendar appointments #120

Cleanup

• codebase cleanup using RUFF #102
• test case improvements #104 #113
• various smaller fixes

Full Changelog: 1.6.1...1.7.0

Some functionality might not be fully functional with CT yet - See open Support cases
https://github.com/bensteUEM/ChurchToolsAPI/labels/Support%20Case%20with%20CT

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.7.0#egg=churchtools-api

1.6.0

Updated release with

• /groups - new endpoints - thanks to @fschrempf
• /bookings basic endpoints
• /events extended functionality for special use cases
• pagination fixes and cleanup
• updated logging

Full Changelog: 1.5.3...1.6.0

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.6.0#egg=churchtools-api

1.5.1

Updated Version 1.5 with new project structure including use of poetry for dependencies
Methods are still the same however the import changed.
package is now called "churchtools-api" the module to be imported is now called "churchtools_api", the class names stayed "ChurchToolsApi"

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.5.1#egg=ChurchToolsAPI

1.4.2

Updated 1.4 release thanks to new functions from @fschrempf

• #72 Implement get_groups_hierarchies()
• #73 (Implement get_grouptypes()
• #74 Implement get_group_permissions()
• #75 Implement update_group()
• #76 Implement get_global_permissions()

Additional functionality is added only - all existing code should still work like before

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.4.2#egg=ChurchToolsAPI

1.4.1

Maintanance release

• does implement the split of API and WebHelper
• Readme update
• Jupyter Notebook

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.4.1#egg=ChurchToolsAPI

1.4.0

Split Web UI from API - this release only contains the ChurchToolsAPI wrapper without additional docker or Communi overhead.

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.4.0#egg=ChurchToolsAPI

1.3.11

Updated for communi integration - NOT FINISHED!

Install as package using:
pip install git+https://github.com/bensteUEM/ChurchToolsAPI.git@1.3.11#egg=ChurchToolsAPI

or use docker image at
ghcr.io/bensteuem/churchtools_webservice:latest