Einführung

PyFabricate ist eine Mac OS X-Anwendung, die die Erstellung von Python-Projekten vereinfacht. Da ich es verfasst habe, handelt es sich offensichtlich um eine Meinungsversion dessen, wie meiner Meinung nach ein Python-Projekt aussehen sollte. Darüber hinaus verfüge ich über ein bestimmtes Toolset, mit dem ich Python-Anwendungen für Mac OS X schreiben kann. Ich habe jedoch versucht, ein wenig Anpassung vorzunehmen, indem ich die Vorlagen offengelegt habe, aus denen ich Projektdateien erstelle. Mehr dazu später.

Überblick

PyFabricate verwendet eine assistentenähnliche Oberfläche, um die Projektdetails abzufragen.

Meinungsbasierte Annahmen

• Der Entwickler verwendet HomeBrew, um die meinungsgemäßen Abhängigkeiten zu installieren.

  • Python wird über pyenv verwaltet (zur Verwendung in den erstellten virtuellen Umgebungen)
  • direnv ist installiert (optional)

• Der Projektname ist derselbe wie der Modulpaketname

Installation

Die aktuelle Version finden Sie hier.

Kopieren Sie diese Datei in Ihren Mac OS-Anwendungsordner. Die Anwendung ist mit Apple-Code signiert, sodass Sie bei der ersten Ausführung eine einfache Meldung erhalten, die Sie bestätigen müssen.

Details zum Projektskelett

Das Folgende ist ein Beispiel des anfänglichen Skeletts, das PyFabricator erstellt. Es zeigt jetzt die virtuelle Umgebung an, die es erstellt. Mehr dazu später.

Im Wesentlichen erstellt PyFabricate die Quell- und Testverzeichnisse. Im Projektstammverzeichnis werden folgende Dateien erstellt:

• .envrc
• .gitignore
• .mypi.ini
• .python_version
• .LIZENZ
• README.md
• pyproject.toml
• requirements.txt

Darüber hinaus erstellt PyFabricate alle Python-Paketdateien (__init__.py) an allen entsprechenden Stellen. Und schließlich werden zwei Sätze von Protokollierungskonfigurationsdateien abgelegt, einer für Ihre Anwendung und einer für Ihre Komponententests.

Am Ende der Herstellung erstellt PyFabricate eine virtuelle Python-Umgebung. Aufgrund technischer Einschränkungen kann PyFabricate keine Pyenv-Version von Python zum Erstellen der virtuellen Umgebung verwenden. Daher kommt es auf eine Homebrew-installierte Version an.

Assistenten-Benutzeroberfläche

Die Benutzeroberfläche des Assistenten ist ein 4-stufiger Prozess, bei dem PyFabricate ausreichend Projektdetails sammelt, die zum Auffüllen der Grundvorlagen verwendet werden. Die Vorlagen verwenden die folgenden selbsterklärenden Substitutionstoken.

Das Folgende ist eine kommentierte Grafik der pyroject.toml-Vorlage.

Assistenten-Benutzeroberfläche Schritt 1 – Einführung

Dieser Schritt ist eine Einführung in PyFabricate. Nach diesem Schritt unternimmt PyFabricate sein Bestes, um sicherzustellen, dass seine Ausführungsabhängigkeiten erfüllt sind. Andernfalls kann der Entwickler nicht über diesen Schritt hinaus fortfahren.

Assistenten-Benutzeroberfläche Schritt 2 – Projektdetails

In diesem Schritt sammelt PyFabricate projektspezifische Informationen. Der größte Teil davon dient dazu, die Vorlage pyproject.toml zu füllen.

Assistenten-Benutzeroberfläche Schritt 3 – Basisverzeichnis

PyFabricate geht davon aus, dass der Entwickler alle seine Python-Projekte in einem einzigen Unterverzeichnis speichert. Dies ist eine Meinungsmeinung und lediglich eine organisatorische Präferenz.

Assistenten-Benutzeroberfläche Schritt 4 – Python-Version

PyFabricate fragt pyenv nach den vom Entwickler installierten Python-Versionen ab. Dies sind die einzigen, aus denen PyFabricate virtuelle Python-Umgebungen erstellen kann.

Aktionsprotokoll

Am Ende des Assistenten präsentiert PyFabricate ein Protokoll, während das Projekt erstellt wird. Das Folgende ist ein Beispielprotokoll.

Anpassung

Wie bereits erwähnt, kann der Entwickler einige Aspekte der Projektgenerierung anpassen. PyFabricate speichert die verwendeten Vorlagen in $HOME/.config/pyfabricate/templates, wie unten angegeben.

Beispielsweise möchte ein Entwickler möglicherweise eine Differenzlizenz verwenden. Ersetzen Sie einfach die Datei LICENSE.template

Einpacken

PyFabricate ist derzeit nur in Version 0.5.0 verfügbar. Ich untersuche derzeit das Hinzufügen zusätzlicher Funktionen und das Entfernen von Einschränkungen.