Einrichten einer Entwicklungsumgebung¶
Um zu BeeWare beizutragen, müssen Sie eine Entwicklungsumgebung einrichten.
Voraussetzungen¶
Sie müssen die folgenden Voraussetzungen installieren.
BeeWare erfordert Python 3.10+. Sie benötigen auch
eine Methode zur Verwaltung virtueller Umgebungen (wie venv).
Sie können die Version von Python, die Sie installiert haben, überprüfen, indem Sie diese ausführen:
$ python3 --version
Wenn Sie mehr als eine Version von Python installiert haben, müssen Sie
eventuell python3 durch eine bestimmte Versionsnummer ersetzen (z.B. python3.13)
Wir empfehlen, kürzlich veröffentlichte Versionen von Python zu vermeiden (d.h. Versionen, die eine ".0" oder ".1" Mikro-Versionsnummer haben, wie z.B. 3.14.0). Der Grund dafür ist, dass die Werkzeuge, die zur Unterstützung von Python unter macOS benötigt werden, in der Regel nicht für kürzlich veröffentlichte stabile Python-Versionen verfügbar sind.
BeeWare erfordert Python 3.10+. Sie benötigen auch
eine Methode zur Verwaltung virtueller Umgebungen (wie venv).
Sie können die Version von Python, die Sie installiert haben, überprüfen, indem Sie diese ausführen:
$ python3 --version
Wenn Sie mehr als eine Version von Python installiert haben, müssen Sie
eventuell python3 durch eine bestimmte Versionsnummer ersetzen (z.B. python3.13)
Wir empfehlen, kürzlich veröffentlichte Versionen von Python zu vermeiden (d.h. Versionen, die eine ".0" oder ".1" Mikro-Versionsnummer haben, wie z.B. 3.14.0). Der Grund dafür ist, dass die Werkzeuge, die zur Unterstützung von Python unter Linux benötigt werden, oft nicht für kürzlich veröffentlichte stabile Python-Versionen verfügbar sind.
BeeWare erfordert Python 3.10+. Sie benötigen auch
eine Methode zur Verwaltung virtueller Umgebungen (wie venv).
Sie können die Version von Python, die Sie installiert haben, überprüfen, indem Sie diese ausführen:
C:\...>py -3 --version
Wenn Sie mehr als eine Version von Python installiert haben, müssen Sie
möglicherweise die -3 durch eine bestimmte Versionsnummer ersetzen (z.B.
-python3.13)
Wir empfehlen, kürzlich veröffentlichte Versionen von Python zu vermeiden (d.h. Versionen, die eine ".0" oder ".1" Mikro-Versionsnummer haben, wie z.B. 3.14.0). Der Grund dafür ist, dass die Werkzeuge, die zur Unterstützung von Python unter Windows benötigt werden, in der Regel nicht für kürzlich veröffentlichte stabile Python-Versionen verfügbar sind.
Richten Sie Ihre Entwicklungsumgebung ein¶
Es wird empfohlen, die Entwicklungsumgebung für BeeWare in einer virtuellen Umgebung einzurichten und dann die Entwicklungsversion von BeeWare und seine Abhängigkeiten zu installieren.
Klonen Sie das BeeWare Repository¶
Gehen Sie als Nächstes zur BeeWare Seite auf GitHub, und, falls noch nicht geschehen, forken Sie das Repository in Ihr eigenes Konto. Klicken Sie anschließend auf die Schaltfläche "<> Code" auf Ihrem Fork. Wenn Sie die GitHub-Desktop-Anwendung auf Ihrem Computer installiert haben, können Sie "Mit GitHub-Desktop öffnen" wählen; andernfalls kopieren Sie die angegebene HTTPS-URL und verwenden sie, um das Repository über die Befehlszeile auf Ihren Computer zu klonen:
Forken Sie das BeeWare Repository, und dann:
$ git clone https://github.com/<your username>/beeware.git
(ersetzen Sie Ihren GitHub-Benutzernamen)
Forken Sie das BeeWare Repository, und dann:
$ git clone https://github.com/<your username>/beeware.git
(ersetzen Sie Ihren GitHub-Benutzernamen)
Forken Sie das BeeWare Repository, und dann:
C:\...>git clone https://github.com/<your username>/beeware.git
(ersetzen Sie Ihren GitHub-Benutzernamen)
Erstellen einer virtuellen Umgebung¶
Um eine virtuelle Umgebung einzurichten und pip zu aktualisieren, führen Sie
aus:
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
Ihre Eingabeaufforderung sollte nun ein Präfix (.venv) vorangestellt haben.
Installieren Sie BeeWare¶
Jetzt, da Sie den Quellcode haben, können Sie eine editierbare Installation von BeeWare in Ihrer Entwicklungsumgebung durchführen. Führen Sie den folgenden Befehl aus:
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
Pre-Commit aktivieren¶
BeeWare verwendet ein Tool namens pre-commit, um einfache Probleme zu identifizieren und die Codeformatierung zu standardisieren. Zu diesem Zweck wird ein Git-Hook installiert, der automatisch eine Reihe von Code-Linters ausführt, bevor ein Git-Commit abgeschlossen wird. Um pre-commit zu aktivieren, führen Sie aus:
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
Jetzt können Sie mit dem Hacken von BeeWare beginnen!