simplified local execution by adding Jupyter Notebook

Author: bensteUEM

README.md

@@ -48,7 +48,9 @@ The respective function do have a hint like the one below in the docstring of th
 IMPORTANT - This test method and the parameters used depend on the target system!
 ```
 
-You 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)
+You 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)+
+
+There is also a main.ipynb which can be used to quickly execute single actions without writing a seperate python project
 
 ## Compatibility
 

main.ipynb

@@ -0,0 +1,61 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# How to Use:\n",
+    "This Notebook should ease the use of the API for \"cleanup\" tasks. It includes some sample for specific use cases that can be adjusted.\n",
+    "1. run first block to prepare excecutions by creating api connection\n",
+    "2. run any following block to execute a specific function"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "from ChurchToolsApi import ChurchToolsApi\n",
+    "\n",
+    "logging.getLogger().setLevel(logging.INFO)\n",
+    "logging.info(\"Started main\")\n",
+    "\n",
+    "# Create Session\n",
+    "from secure.config import ct_domain\n",
+    "from secure.config import ct_token\n",
+    "api = ChurchToolsApi(ct_domain)\n",
+    "api.login_ct_rest_api(ct_token=ct_token)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Song Tag - mass change\n",
+    "Helper to append a tag to all songs - e.g. 51 is tag:\"in ChurchTools vor Skript Import\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "songs = api.get_songs()\n",
+    "all_song_ids = [value['id'] for value in songs]\n",
+    "for id in all_song_ids:\n",
+    "    api.add_song_tag(id, 51)"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}