docs: add Handout

Handout.md

@@ -0,0 +1,91 @@
+# Suchanalyse: Häufigkeit von Zeichenketten
+
+Von Matthias Unternährer, Pedro Alexandre Almeida Figueiredo und Tuan Binh Tran
+
+# Einleitung
+
+Dieses Handout beschreibt unsere eigene Lösung zur Python-Aufgabe "Suchanalyse: Häufigket von Zeichenketten".
+Dabei sind unsere Funktion und Tests beschrieben. Auch unsere Gedanken sind festgehalten.
+
+Die Ziele und Bewertung sind der Aufgabe [Programmieren Grundlagen](https://github.com/fhirter/Software-Engineering/blob/master/ProgrammingBasicsAndAlgorithms/Exercises/Basics/Tasks.md) zu entnehmen.
+
+
+# Suchen: Anforderungen
+
+- Das Suchen der Zeichenkette beachtet die Gross- und Kleinschreibung (case-sensitive).
+- Ein gesuchter Zeichenabfolge darf nicht nochmals für die Häufigkeit genutzt werden.
+  - Beispiel: Wird im Text "ABBBC" nach "BB" gesucht, so ist die Häufigkeit 1 und nicht 2.
+- Es wird die Häufigkeit von der gesuchten Zeichenkette ausgegeben.
+
+# Aufbau
+
+Das Repository ist wie gefolgt aufgebaut:
+
+- `/`
+  - `search.py`: Die Suchfunktion
+  - `search_tests.py`: Unit Tests, welche die Suchfunktion testet
+  - `.gitignore`: Ignorieren von Dateien im Git
+  - `README.md`: Das README File
+  - `Protokoll.md`: Das Protokoll
+  - `Handout.md`: Du bist hier
+  - `.github`
+    - `workflows`
+      - `test.yml`: Workflow, welches die Unit Tests ausführt. 
+
+# Beschreibung der Suchfunktion
+
+Die Suchfunktion akzeptiert zwei Parameter. Beim ersten Parameter handelt sich um den Text. Mit dem zweiten Parameter wird der Suchtext angegeben.
+
+Die beiden Parameter werden nicht validiert. Dementsprechend schlägt die Funktion fehl, wenn es sich um keine Strings handelt.
+
+Die Funktion initialisiert zum Start zwei Variablen:
+- `occurrences = 0`: Die Häufigkeit der Zeichenkette im Text
+- `currentIndex = 0`: Die nächste Index Position im Text.
+
+Nach der Initialisierung der benötigen Variablen, wird ein Loop gestartet. Dieser Loop wiederholt sich solange bis der `currentIndex` grösser-gleich die Länge vom Text erreicht.
+Bei jedem Loop durchgang wird folgendes geprüft und ausgeführt:
+
+1. Handelt es sich bei der momentanen Index Position vom Text plus die Länge vom gesuchten Text, um die Zeichenkette?
+
+Wenn ja, erhöhe die Häufigkeit um eins und erhöhe die Varialbe `currentIndex` um die Länge der gesuchten Zeichenkette minus eins.
+
+2. Inkrementiere `currentIndex` um eins.
+
+Sobald der Loop durch ist, wird die `occurrences` zurückgegeben.
+
+[![](https://mermaid.ink/img/pako:eNplkklvwjAQhf_KaE6tWJREIZioVCrdoFJR1dJLSQ9WMhCriV0ZRyyB_94sgILqk2f0vTfPS46high9XCRqHcZcG5g9BBKKdXc1mb59zmBGGwNcRvBBXIdxWV5Dp3MLo_lECiN4InYEKgwzrUmGtIIhWJWg7piJjGhTNr9r41Glvs_XsUjoEroBU05LSC5NfKjx-xLfv_A9POYXcOvIgVrA6pwNhsNGdfR4PHs8zZtJW0Owj6meqlTP88sRTa_TuM5ZU9tOScg9jP8pT9Rz5Tyui3F9-ObRpmoPk6t3MpmWzXu8xjampFMuouKB8lISoIkppQD9Yhtx_RNgIA8FxzOjPrYyRN_ojNqoVbaM0V_wZFVU2W_EDT0IvtQ8PXd_ufxSKj1JKBJG6df6O4RKLsQSKwj9HDfo28ztOj2XMYfZTq-NW_SdftcbWGxgO16PeQPbPbRxV1laXeZazHP7vb5nWw7rs8MfmSnBCg?type=png)](https://mermaid.live/edit#pako:eNplkklvwjAQhf_KaE6tWJREIZioVCrdoFJR1dJLSQ9WMhCriV0ZRyyB_94sgILqk2f0vTfPS46high9XCRqHcZcG5g9BBKKdXc1mb59zmBGGwNcRvBBXIdxWV5Dp3MLo_lECiN4InYEKgwzrUmGtIIhWJWg7piJjGhTNr9r41Glvs_XsUjoEroBU05LSC5NfKjx-xLfv_A9POYXcOvIgVrA6pwNhsNGdfR4PHs8zZtJW0Owj6meqlTP88sRTa_TuM5ZU9tOScg9jP8pT9Rz5Tyui3F9-ObRpmoPk6t3MpmWzXu8xjampFMuouKB8lISoIkppQD9Yhtx_RNgIA8FxzOjPrYyRN_ojNqoVbaM0V_wZFVU2W_EDT0IvtQ8PXd_ufxSKj1JKBJG6df6O4RKLsQSKwj9HDfo28ztOj2XMYfZTq-NW_SdftcbWGxgO16PeQPbPbRxV1laXeZazHP7vb5nWw7rs8MfmSnBCg)
+
+
+# Unit Tests
+
+Die Unit Tests wurde im TDD-Verfahren erstellt.
+
+Für die detaillierte Implementation siehe `search_test.py`.
+
+
+
+# Workflow: Python Test ausführen
+
+Der Workflow auf Github führt die Tests durch und liefert das Ergebnis.
+
+Dieser wird momentan manuell ausgelöst, kann aber problemlos auf "on push" umgeschaltet werden, welches jedes ausgelöst sobald neue Änderungen im Hauptbranch gemerged sind.
+
+Der Ablauf ist wie gefolgt:
+
+1. Der Worflow wird manuell ausgelöst.
+2. Das Repository wird geholt (checkout).
+3. Setup Python wird ausgeführt, welches die Angebene Python Version herunterlädt und einrichtet.
+4. Unit Tests im `search_tests.py` werden ausgeführt.
+
+
+# Erkenntnisse
+- Online ist sehr viel über Python beschrieben.
+- Die Collaboration mit Git ohne Branches führt zu Probleme.
+
+# Quellen
+
+- Python For-Loops: https://www.w3schools.com/python/python_for_loops.asp
+- Iterating String using For Loop: https://sparkbyexamples.com/python/iterate-string-in-python-using-for-loop/
+- Python Functions: https://www.w3schools.com/python/python_functions.asp
+- Python unittest - Unit testing Framework: https://docs.python.org/3/library/unittest.html
+- Python Variables: https://www.w3schools.com/python/python_variables.asp

README.md

@@ -7,7 +7,6 @@ Zum Beispiel: Wie oft kommt "A" vor.
 
 - Es ist Case-Sensitive
 - Es kann nach einer Zeichenfolge gesucht werden
-- Es soll die Anzahl und die Stellen (Position, Index) ausgeben
 
 # Flow Chart
 [![](https://mermaid.ink/img/pako:eNplkklvwjAQhf_KaE6tWJREIZioVCrdoFJR1dJLSQ9WMhCriV0ZRyyB_94sgILqk2f0vTfPS46high9XCRqHcZcG5g9BBKKdXc1mb59zmBGGwNcRvBBXIdxWV5Dp3MLo_lECiN4InYEKgwzrUmGtIIhWJWg7piJjGhTNr9r41Glvs_XsUjoEroBU05LSC5NfKjx-xLfv_A9POYXcOvIgVrA6pwNhsNGdfR4PHs8zZtJW0Owj6meqlTP88sRTa_TuM5ZU9tOScg9jP8pT9Rz5Tyui3F9-ObRpmoPk6t3MpmWzXu8xjampFMuouKB8lISoIkppQD9Yhtx_RNgIA8FxzOjPrYyRN_ojNqoVbaM0V_wZFVU2W_EDT0IvtQ8PXd_ufxSKj1JKBJG6df6O4RKLsQSKwj9HDfo28ztOj2XMYfZTq-NW_SdftcbWGxgO16PeQPbPbRxV1laXeZazHP7vb5nWw7rs8MfmSnBCg?type=png)](https://mermaid.live/edit#pako:eNplkklvwjAQhf_KaE6tWJREIZioVCrdoFJR1dJLSQ9WMhCriV0ZRyyB_94sgILqk2f0vTfPS46high9XCRqHcZcG5g9BBKKdXc1mb59zmBGGwNcRvBBXIdxWV5Dp3MLo_lECiN4InYEKgwzrUmGtIIhWJWg7piJjGhTNr9r41Glvs_XsUjoEroBU05LSC5NfKjx-xLfv_A9POYXcOvIgVrA6pwNhsNGdfR4PHs8zZtJW0Owj6meqlTP88sRTa_TuM5ZU9tOScg9jP8pT9Rz5Tyui3F9-ObRpmoPk6t3MpmWzXu8xjampFMuouKB8lISoIkppQD9Yhtx_RNgIA8FxzOjPrYyRN_ojNqoVbaM0V_wZFVU2W_EDT0IvtQ8PXd_ufxSKj1JKBJG6df6O4RKLsQSKwj9HDfo28ztOj2XMYfZTq-NW_SdftcbWGxgO16PeQPbPbRxV1laXeZazHP7vb5nWw7rs8MfmSnBCg)