ChurchTools Utilities

Die ChurchTools Utilities bestehen aus folgender Funktion:

  1. Erweitere Führungszeugnisse

Weitere Funktionen können späterhinzukommen.

Source code auf GitHub: https://github.com/ftwegner/ChurchTools

Installation

Stelle sicher, dass Python und git auf deinem Rechner installiert und eingerichtet sind.

Um das ChurchTools Utilities Git-Repository auf deinen Windows-Rechner zu klonen, folge diesen Schritten:

  1. Öffne die PowerShell oder Eingabeaufforderung: Drücke Win + R, gib powershell oder cmd ein und drücke Enter.

  2. Navigiere zu dem Ordner, in dem du das Repository speichern möchtest

  3. Klonen des Repositories: Führe den folgenden Befehl aus: bash git clone https://github.com/ftwegner/ChurchTools.git

  4. Wechsle in das geklonte Verzeichnis: bash cd ChurchTools

  5. Erstelle eine virtuelle Python Umngebung: python -m venv .venv .\.venv\Scripts\activate pip install -r requirements.txt Das Repository ist jetzt auf deinem Rechner verfügbar. Du kannst es in Visual Studio Code (verfügbar für Windows/Mac/Linux/Raspberry Pi) oder einem anderen Werkzeug deiner Wahl öffnen, um es im nächsten SChritt zu konfigurieren.

Konfiguration

Die Konfiguration besteht aus zwei Teilen:

  1. Access Token holen
  2. Umgebungsvariable CHURCHTOOLS_TOKEN setzen
  3. API Base URL setzen

1. Access Token

Damit die ChurchTools Utilities funktioneren, muss auf dem Rechner, auf dem die Utilities laufen, die Umgebungsvariable CHURCHTOOLS_TOKEN mit dem ChurchTools Access Token angelegt sein.

ChurchTools Access Token besorgen

In ChurchTools Web bekommst du das Token in Personen & Gruppen > Personenliste > „Person A“ > Berechtigungen > Login-Token

2. Umgebungsvariablen setzen

Variable Wann nötig Beschreibung
CHURCHTOOLS_TOKEN immer ChurchTools Access Token
USE_EMAIL optional true → E-Mail-Versand einschalten (Standard: aus)
SMTP_SERVER bei E-Mail-Versand Hostname des SMTP-Servers, z. B. smtp.example.com
SMTP_PORT optional Port des SMTP-Servers (Standard: 587, STARTTLS)
SMTP_USERNAME bei E-Mail-Versand Absenderadresse / Login des SMTP-Kontos
SMTP_PASSWORD bei E-Mail-Versand Passwort des SMTP-Kontos
EMAIL_RECIPIENTS bei E-Mail-Versand Komma-separierte Liste der Empfänger

Die Schritte unten zeigen das Setzen am Beispiel CHURCHTOOLS_TOKEN; die anderen Variablen werden genauso angelegt.

Windows

Um die Umgebungsvariable CHURCHTOOLS_TOKEN für den aktuellen Benutzer in Windows zu setzen, führe die folgenden Schritte aus:

  1. Öffne die Umgebungsvariablen-Einstellungen:
  2. Drücke Win + R, gib sysdm.cpl ein und drücke Enter.

  3. Gehe zum Tab Erweitert und klicke auf Umgebungsvariablen.

  4. Neue Benutzer-Umgebungsvariable hinzufügen:

  5. Klicke unter Benutzervariablen für <Benutzername> auf Neu.
  6. Setze den Namen der Variablen auf CHURCHTOOLS_TOKEN.

  7. Setze den Wert der Variablen auf deinen Token.

  8. Speichern und Schließen:

  9. Klicke auf OK, um die Änderungen zu speichern.

  10. Schließe alle Dialoge.

  11. PowerShell neu starten: Starte die PowerShell neu, damit die Änderungen wirksam werden.

  12. Überprüfen, ob die Variable gesetzt ist Führe in der PowerShell den folgenden Befehl aus, um zu überprüfen, ob die Umgebungsvariable korrekt gesetzt wurde:

echo $env:CHURCHTOOLS_TOKEN

Linux und Raspberry Pi

Um eine Umgebungsvariable permanent für einen Benutzer auf einem Linux System oder einem einem Raspberry Pi zu setzen, kannst du die .bashrc-Datei des Benutzers bearbeiten. Hier sind die Schritte:

  1. Öffne die .profile-Datei und füge die Umgebungsvariable hinzu Füge am Ende der Datei die folgende Zeile hinzu und speichere die Datei:
export CHURCHTOOLS_TOKEN="<token value here>"
  1. Aktualisiere die Umgebungsvariablen Lade die .profile-Datei neu, damit die Änderungen wirksam werden:
source ~/.profile
  1. Überprüfe die Umgebungsvariable Prüfe, ob die Umgebungsvariable korrekt gesetzt wurde:
echo $CHURCHTOOLS_TOKEN

Wenn der Token angezeigt wird, ist die Umgebungsvariable korrekt gesetzt.

3. API Base URL

Setze die BASE URL in der Datei config.py auf den Wert für deine Kirchengemeinde:

# Base URL der ChurchTools Instanz API
BASE_URL = "https://volksdorf.church.tools/api"

Nächste Schritte

  1. Führe die Konfiguration der einzelen Funktionen durch:
  2. Erweiterte Führungszeugnisse
  3. Gib mir Feedback.