Installation

Installation#

Die μEdition baut auf einer Reihe von Werkzeugen auf und um die erste μEdition zu erstellen, müssen diese Werkzeuge installiert werden.

Die μEdition nutzt Python und unterstützt Versionen 3.10 und 3.11 [1]. Bitte installieren sie die Python Version für ihr Betriebssystem.

Für die Erstellung einer μEdition wird ein Werkzeug namens Copier genutzt. Für die Installation aller weiteren Abhängigkeiten und um die verschiedenen μEdition Funktionen aufzurufen wird Hatch genutzt.

Die einfachste Weise um beide zu installieren ist mittels pipx, welches von hier installiert werden kann. Nach der pipx installation nutzen sie die folgenden zwei Befehle um Copier und Hatch zu installieren:

$ pipx install copier
$ pipx install hatch

Um zu überprüfen, dass die Installationen erfolgreich waren, nutzen sie die folgenden Befehle:

$ copier
$ hatch

Wenn beide Befehle eine Zusammenfassung der verfügbaren Optionen und Befehle für die zwei Werkzeuge anzeigen, dann sind beide Werkzeuge korrekt installiert.

Um im Team zusammenzuarbeiten und für die GitHub Pages Veröffentlichungsfunktionalität, muss auch das Versionskontrollwerkzeug Git installiert sein. Eine vollständige Einführung in Git übersteigt den Platz hier, aber es gibt viele gute Tutorials im Netz und die offizielle Dokumentation ist auch hilfreich.