create-cheatsheet (#48)

* feat: Add cheatsheet and todo list for cheatsheet content

* feat: Enhance usage instructions

* feat: Add basic content to Cheatsheet
Complete Markdown cheatsheet code examples

Update cheatsheet_syntax_todo.md to mark and add concrete code examples and common patterns from 900-Cheatsheet.md. Many checklist items under basic operations, assignment, number formats, type conversion, variables, strings, I/O, control flow, loops, functions, and imports were completed (checked) and several example lines were added for multiple/chained assignment, string operations, range/enumerate, loop control, default function parameters, and function usage to make the cheatsheet immediately usable and consistent with the master cheatsheet.

Author: schnaitter

000-Einleitung/Nutzung_des_Kurses.md

@@ -3,8 +3,6 @@ numbering:
     heading_1: true
     heading_2: true
     title: true
-    figure:
-        template: Abb. %s
 ---
 
 # Nutzung des Kurses
@@ -24,14 +22,92 @@ wiederholen? Können Sie das gelernte auf ein ähnliches Problem anwenden?
 
 ### Lesen
 
+Lesen Sie den Text aufmerksam durch. Ich empfehle eine "Seite" einmal ganz zu
+überfliegen und dann den Text Abschnitt für Abschnitt durchzuarbeiten. Denken
+Sie nicht, dass Sie eine Seite als Ganzes am Stück durcharbeiten müssen.
+Arbeiten Sie lieber jeden Tag für 15 Minuten am Kurs als alle paar Tage/Wochen
+einen größeren Zeitblock lang.
+
 ### Bearbeiten
 
+Das reine Lesen reicht nicht für das Erlernen von Programmierung! Programmieren
+ist eher mit einem Handwerk zu vergleichen. Nur weil Sie YouTube-Videos
+angesehen haben, wie man Maschinenteile fräst können Sie das nicht.
+
+Kopieren Sie auch nicht nur Code, sondern tippen Sie ihn selbst. Das
+nachfolgende Zitat von
+[Daniel Holden](https://www.buildyourownlisp.com/chapter1_introduction#:~:text=Throughout%20the%20book,the%20writing%20yourself!)
+beschreibt dies sehr schön:
+
+> Throughout the book I'll be giving description and insight, but with it I'll
+> be providing a lot of code. This will make it easy to follow along by copy
+> and pasting each section into your program without really understanding.
+> Please do not do this!.
+>
+> Type out each piece of sample code yourself. This is called The Hard Way. Not
+> because it is hard technically, but because it requires discipline. By doing
+> things The Hard Way you will come to understand the reasoning behind what you
+> are typing. Ideally things will click as you follow it along character by
+> character. When reading you may have an intuition as to why it looks right,
+> or what may be going on, but this will not always translate to a real
+> understanding unless you do the writing yourself!
+
 ### Experimentieren
 
+Experimentieren Sie mit den Beispielen. Ändern Sie Werte, (Variablen-)Namen,
+Leerzeichen, Zeilenumbrüche, Klammern und vieles mehr und sehen Sie, was
+passiert. So bauen Sie ein mentales Modell dafür auf, welche Änderungen im
+Verhalten oder Fehlermeldungen Sie erwarten, wenn Sie etwas verändern, und Sie
+lernen besser mit den Fehlermeldungen umzugehen.
+
+So gut wie kein Code den Sie schreiben werden wird beim ersten Versuch
+funktionieren und das tun, was Sie wollten. Sie werden syntaktische Fehler –
+Zeichen vergessen, Namen falsch schreiben, … – und logische Fehler –
+Bedingungen "falsch herum" definieren, Werte um ±1 falsch definieren, … –
+machen. Das ist normal und passiert auch den erfahrensten Programmierern
+andauern. Nutzen Sie die Gelegenheit, diese Fehlertoleranz und insb. auch das
+Beheben der Fehler zu erlernen. Und wenn Sie "alles kaputt gemacht haben", dann
+starten Sie einfach wieder mit einem früheren Zustand, der gesichert
+funktioniert hat.
+
 ### Programmieren
 
+Die letzte Nutzungsform des Kurses ist das Anwenden des Gelernten auf eigene
+Probleme. Gibt es eine Berechnung, die Sie regelmäßig durchführen? Schreiben
+Sie sich ein Skript, das Ihnen hilft. Haben Sie eine Tabelle mit Nutzungsdaten,
+die Sie gerne auswerten wollen. Nutzen Sie beim nächsten Mal Python und nicht
+Excel.
+
+Fangen Sie mit kleinen Problemen an, und wenn Sie Ihr Projekt nicht vollständig
+umsetzten konnten ist das auch nicht schlimm. Sie haben dennoch etwas gelernt,
+was Sie beim nächsten Problem nutzen können um näher an dessen Lösung zu
+kommen.
+
 ## Self-Assessment
 
+Im Kurs verteilt finden Sie kleine Quizze und Übungen. Nutzen Sie diese um Ihr
+Wissen und Ihre Fähigkeiten zu überprüfen. Wenn Sie etwas falsch beantwortet
+haben, recherchieren Sie, warum es falsch war und denken Sie darüber nach,
+warum Sie die falsche Antwort gegeben haben.
+
 ## Übungsprojekte
 
+Ein Kapitel im Kurs schließt mit einem größeren Projekt ab, welches dann als
+Übung erweitert werden kann. Ich empfehle Ihnen stark, diese Übungen anzugehen
+und wenigstens teilweise durchzuarbeiten.
+
+Für Studierende im Fernstudium Bibliotheks- und Informationswissenschaft finden
+Sie dort jeweils Informationen dazu, was als _Kleine Aufgabe_ angerechnet
+werden kann.
+
 ## Auswahl der Inhalte für das Selbststudium
+
+Wenn Sie noch keine Programmiererfahrung haben, starten Sie am besten von
+Anfang an. Haben Sie schon etwas oder auch viel Erfahrung, steigen Sie gerne
+irgendwo ein oder suchen Sie sich bestimmte Inhalte heraus.
+
+So oder so sollten Sie keine Scheu davor haben auch nochmal zu früheren
+Inhalten zurückzukehren.
+
+Am Ende des Buchs finden Sie ein [Cheatsheet](../900-Cheatsheet.md) welches Python-Syntax und
+-Konzepte nochmals kurz erklärt. Nutzen Sie dieses um sich wieder zu erinnern.

900-Cheatsheet.md

@@ -0,0 +1,295 @@
+---
+numbering:
+    heading_1: true
+    heading_2: true
+    title: true
+---
+
+# Cheatsheet
+
+```{danger} Einrückung
+Python-Code muss korrekt eingerückt sein. Es sollten pro Einrückungsebene genau 4 Leerzeichen genutzt werden.
+```
+
+## Zahlen
+
+### `int()`
+
+```python
+ganzzahl = 42
+ganzzahl = int(42)
+von_string = int("123")
+von_float = int(3.14)                  # Ergebnis: 3
+riesige_zahl = 1234567890987654321
+lesbare_zahleneingabe = 4_294_967_296  # 4294967296
+```
+
+### `float()`
+
+```python
+kommazahl = 3.14
+kommazahl = float(3.14)
+von_string = float("2.5")
+von_int = float(42)       # Ergebnis: 42.0
+```
+
+## Arithmetik
+
+```python
+addition = 5 + 3             # 8
+subtraktion = 10 - 4         # 6
+multiplikation = 6 * 7       # 42
+multiplikation_float = 6.0*7 # 42.0
+division = 15 / 3            # 5.0
+ganzzahldivision = 17 // 5   # 3
+modulo = 17 % 5              # 2
+potenz = 2 ** 3              # 8
+```
+
+## Zeichenketten (`str()`)
+
+```python
+text = "Hallo Welt"
+zahl_zu_string = str(42)            # "42"
+verkettung = "Hallo" + " " + "Welt" # "Hallo Welt"
+wiederholung = "Ha" * 3             # "HaHaHa"
+laenge = len("Python")              # 6
+grossbuchstaben = "python".upper()  # "PYTHON"
+kleinbuchstaben = "PYTHON".lower()  # "python"
+
+# Escape-Sequenzen
+text = "Wie geht's?"
+text = 'Wie geht\'s?'
+erzählung = "Sie sagt: \"So geht das!\""
+neue_zeile = "Zeile 1\nZeile 2"
+tabulator = "Text\teingerückt\n\tauch eingerückt"
+```
+
+## Variablen
+
+```python
+name = "Alice"
+alter = 25
+ist_student = True
+gehalt = 3500.50
+
+# Mehrere Zuweisungen
+x, y, z = 1, 2, 3
+a = b = c = 0
+
+_a = "Unterstrich am Anfang"
+a3 = "Zahlen sind möglich, wenn nicht erstes Zeichen im Namen"
+```
+
+## Funktionen (`def`)
+
+```python
+def begruessung():
+    print("Hallo!")
+
+def addiere(a, b):
+    return a + b
+
+def quadrat(zahl=1):  # Standardwert
+    return zahl ** 2
+
+# Aufrufe
+begruessung()
+ergebnis = addiere(5, 3)  # 8
+wert = quadrat(4)         # 16
+standard = quadrat()      # 1
+```
+
+## Nützliche eingebaute Funktionen
+
+### `print()`
+
+```python
+print("Hallo Welt")                    # Hallo Welt
+print("Name:", "Alice", "Alter:", 25)  # Name: Alice Alter: 25
+print("Ergebnis", 42, sep=" -> ")      # Ergebnis -> 42
+print("Ende", end="!\n")               # Ende!
+
+# Formatierung
+name = "Bob"
+alter = 30
+print(f"Ich bin {name} und {alter} Jahre alt")
+
+
+# Zugriff auf Variable ohne Wert
+print(nicht_existent)                  # Achtung, wirft `NameError()`
+```
+
+### `input()`
+
+```python
+text = input("Wie heißen Sie? ")
+
+zahl = float(input("Zahl > ")   # Achtung, kann `ValueError()` "werfen"
+```
+
+## Bedingungen (`if`)
+
+```python
+alter = 18
+
+if alter >= 18:
+    print("Volljährig")
+elif alter >= 16:
+    print("Fast volljährig")
+else:
+    print("Minderjährig")
+
+# Vergleichsoperatoren: ==, !=, <, <=, >, >=
+# Logische Operatoren: and, or, not
+if alter >= 18 and alter < 65:
+    print("Arbeitsfähig")
+```
+
+## Boolesche Werte
+
+```python
+wahr   = True
+falsch = False
+
+wahr   = True and True
+wahr   = True or False
+
+wahr   = not False
+falsch = not True
+
+falsch = False or False
+falsch = True and False
+```
+
+## Schleifen
+
+### `while`
+
+```python
+zaehler = 0
+while zaehler < 5:
+    print(zaehler)
+    zaehler += 1
+
+# Mit break und continue
+zaehler = 0
+while True:
+    if zaehler == 3:
+        break        # Abbruch der Schleife
+    if zaehler == 1:
+        zaehler += 1
+        continue     # Überspringe den Rest des Codes in der Schleife und starte die nächste Iteration
+    print(zaehler)
+    zaehler += 1
+```
+
+### `for`
+
+```python
+# Über eine Liste iterieren
+fruechte = ["Apfel", "Banane", "Orange"]
+for frucht in fruechte:
+    print(frucht)
+
+# Über einen Bereich iterieren
+for i in range(5):  # 0, 1, 2, 3, 4
+    print(i)
+
+for i in range(2, 8, 2):  # 2, 4, 6
+    print(i)
+
+# Mit enumerate für Index und Wert
+for index, wert in enumerate(fruechte):
+    print(f"{index}: {wert}")
+```
+
+## Importieren von Code (`import`)
+
+```python
+# Gesamtes Modul importieren
+import math
+ergebnis = math.sqrt(16)  # 4.0
+
+# Spezifische Funktionen importieren
+from math import sqrt, pi
+ergebnis = sqrt(25)  # 5.0
+kreisflaeche = pi * 5**2
+
+# Modul mit Alias importieren
+import datetime as dt
+heute = dt.date.today()
+
+# Alles aus einem Modul importieren (nicht empfohlen)
+from math import *
+```
+
+## Dokumentation
+
+### Kommentare
+
+```python
+kein_kommentar # Kommentar
+```
+
+### docstrings
+
+Am Anfang einer Datei, Funktion, Klasse, … kann ein String plaziert werden, welche von der Funktion `help()` für die Dokumentation genutzt wird. Es haben sich verschiedene Formatierungen entwickelt. Hier wird eine vorgestellt.
+
+```python
+"""Lend or return media, if within allowed number of media on account.
+
+Parameters:
+-----------
+account_balance (int): The current balance before the transaction is attempted.
+        Valid values: 0 <= x <= 15
+            
+number_of_media (int): The number of the media to be lent or returned.
+        A positive number signifies lending and a negative Number signifies returning.
+
+Returns:
+--------
+int: The current account balance.
+"""
+```
+
+## Ausführbare Skripte
+
+### Shebang
+
+Nur die erste Zeile des Skripts kann als Shebang benutzt werden!
+
+```python
+#! /usr/bin/env python3
+```
+
+### `if __name__ == "__main__":`
+
+```python
+wird_immer_ausgeführt = 1 # bspw. beim Importieren
+def das_auch():
+    print("wird ausgeführt, wenn die Funktion aufgerufen wird")
+    ...
+
+if __name__ == "__main__":
+    wird_nur_als_skript = "ausgeführt"
+    das_auch()
+```
+
+### Datei ausführbar machen
+
+In Unix-artigen Betriebssystemen.
+
+```bash
+$ chmod +x datei.py
+```
+
+## Python Code ausführen
+
+```bash
+$ python3 code.py
+...
+$ python3 -i code.py
+...
+>>> interaktive_weiterarbeit_möglich = True
+```