Online Magazine
Code-Repository: Es kann so einfach sein!
Ups, ich habe vergessen, eine README hinzuzufügen... schon wieder! Beim Einrichten von Code-Repositories etwas zu vergessen oder falsch zu machen, ist sehr leicht, besonders wenn man mit anderen zusammenarbeitet. Glücklicherweise gibt es eine unkomplizierte Möglichkeit, diesen Prozess zu standardisieren.
von Yves Mauron
Das Einrichten eines neuen Repositorys in einem Projekt ist immer mühsam. Es gibt bestimmte Standards und Vereinbarungen, die eingehalten werden müssen, es gibt obligatorische Dateien, Bereitstellungsartefakte müssen irgendwo abgelegt werden, die Anforderungen sollten sich an einem bestimmten Ort befinden und so weiter und so fort.
Projektvorlagen können eine fantastische Möglichkeit sein, diese Herausforderungen zu entschärfen und die Hürde für neue Teammitglieder zu senken, während gleichzeitig Standards durchgesetzt werden. Ein grossartiges Tool, das die Erstellung und Verwendung solcher Vorlagen erleichtert, ist Cookiecutter.
Cookiecutter ist ein CLI-Tool (Command Line Interface) zur Erstellung von Anwendungs-Boilerplate-Code aus einer Vorlage. Es verwendet Jinja2 als Vorlagensystem, um Ordner- und Dateinamen sowie Dateiinhalte zu ersetzen oder anzupassen. Cookiecutter ist in Python geschrieben, kann aber auch verwendet werden, um Code-Repos für jede andere Programmiersprache zu erzeugen.
Noob Hack
Man benötigt eine funktionierende Python-Installation auf dem Rechner; danach kann Cookiecutter mit dem bevorzugten Paketmanager installiert werden, z.B.:
Pip:
$ pip install --user cookiecutter
Conda:
$ conda install cookiecutter
Jetzt kann eine bestehende Vorlage gesucht und für sein Projekt verwendet werden. Im Folgenden Beispiel wird die von @audreyfeldroy erstellte Vorlage "cookiecutter-pypackage" verwendet, um in kürzester Zeit ein "Best-Practice"-Python-Projekt einzurichten.
Jetzt kann man sich auf das konzentrieren, was wirklich wichtig ist: die Entwicklung der Anwendung! Viel Spass beim Programmieren!
Pro Hack
Wie üblich ist die Wahrscheinlichkeit gross, dass in deinem Unternehmen die Dinge ein wenig anders angegangen werden, oder vielleicht kannst du sogar mehr Standardcode generieren, was das Potenzial von Vorlagen erhöht, Zeit zu sparen und die Wiederverwendbarkeit zu verbessern. Man könnte also beschliessen, eine benutzerdefinierte Vorlage zu erstellen, die an die Bedürfnisse einer Organisation oder eines Teams angepasst ist; im Wesentlichen eine Standardisierung der Vorgehensweise.
Um eine eigene Cookiecutter-Vorlagen zu erstellen, muss man etwas Jinja und Python lernen. Eine gute Möglichkeit, damit zu beginnen, ist dieser Leitfaden und natürlich die jeweiligen Dokumentationsseiten von Jinja und Python.
Neben den oben genannten Gründen macht es auch Spass, eigene Vorlagen zu erstellen, um die Einrichtung von Projekten in der eigenen Organisation zu automatisieren. Denn es zwingt ein Team dazu, darüber nachzudenken, wie man die Dinge am besten macht. Das Ergebnis dieser Diskussionen in eine Vorlage zu packen, die jeder nutzen kann, kann die Effizienz steigern.
