📋 requirements.txt-Datei für Python
Dierequirements.txt-Datei ist der Industriestandard zum Angeben und Verwalten von Abhängigkeiten in Python-Projekten. Diese Anleitung zeigt, wie du requirements.txt erstellst, konfigurierst und verwendest, um Konsistenz zwischen Entwicklungs- und Produktionsumgebungen sicherzustellen.
Was ist eine requirements.txt-Datei?
Einerequirements.txt-Datei listet alle externen Python-Pakete auf, die dein Projekt benötigt, samt ihren spezifischen Versionen. Das ermöglicht:
- Dir und deinem Team, identische Umgebungen zu pflegen
- Neuen Mitwirkenden, die Umgebung exakt zu reproduzieren
- Deploy auf Square Cloud, mit den korrekten Abhängigkeiten zu funktionieren
1
Aktiviere die virtuelle Umgebung
Innerhalb einer virtuellen Umgebung zu arbeiten ist unerlässlich, um die Abhängigkeiten deines Projekts vom globalen Python-System isoliert zu halten. Das vermeidet Versionskonflikte und stellt Reproduzierbarkeit sicher.Aktiviere deine virtuelle Umgebung mit einem der folgenden Befehle, je nach deinem System:Windows:macOS/Linux:
2
Liste die Abhängigkeiten des Projekts auf
Option A: Manuell erstellen (Empfohlen)
Erstelle einerequirements.txt-Datei im Stammverzeichnis deines Projekts und liste alle externen Pakete mit ihren Versionen auf:requirements.txt
Option B: Automatisch mit pip freeze generieren
Nachdem du die Abhängigkeiten in deiner virtuellen Umgebung installiert hast, kannst du die Datei automatisch generieren. Es gibt zwei Hauptwege:Option B1:pip freeze verwenden (schließt alles ein)pipdeptree oder pip freeze mit Filterung verwenden (Empfohlen)Um NUR die Abhängigkeiten deines Projekts zu erfassen (ohne begleitende Umgebungspakete), verwende:pipdeptree:Wenn du in einer virtuellen Umgebung arbeitest (empfohlen), funktioniert
pip freeze einwandfrei, da die Umgebung isoliert ist und nur die Abhängigkeiten deines Projekts enthält.3
Abhängigkeiten überprüfen und validieren
Öffne die
requirements.txt-Datei in deinem Texteditor und:- Überprüfe die Paketliste
- Entferne unnötige Abhängigkeiten
- Aktualisiere Versionen nach Bedarf
- Stelle sicher, dass du exakte Versionen (mit
==) verwendest
4
Abhängigkeiten installieren
Um alle aufgeführten Abhängigkeiten zu installieren:Dieser Befehl garantiert, dass alle Mitwirkenden und Produktionsumgebungen exakt dieselben Versionen verwenden.
5
Versionieren und teilen
Wenn
requirements.txt fertig ist, kannst du:- Sie mit deinem Team teilen
- Sie in die Versionskontrolle (git) aufnehmen
- Sicherstellen, dass alle mit denselben Versionen arbeiten
- Das Deployment auf Square Cloud vereinfachen
requirements.txt-Datei automatisch erkannt und alle Abhängigkeiten werden während des Builds installiert.💡 Best Practices und Tipps:
- Aktuell halten: Überprüfe und aktualisiere
requirements.txtregelmäßig, wenn du neue Abhängigkeiten hinzufügst - Exakte Versionen verwenden: Verwende immer
==statt>,>=oder keiner Version, um Überraschungen in der Produktion zu vermeiden - pip freeze überprüfen: Wenn du
pip freezeverwendest, überprüfe die Datei vor dem Committen, da sie unnötige begleitende Pakete enthalten kann - Versionierung: Committe
requirements.txtin git, um Änderungen an Abhängigkeiten nachzuverfolgen - Isolierte Umgebung: Pflege eine virtuelle Umgebung pro Projekt, um globale Konflikte zu vermeiden
- Lokal testen: Teste die Datei vor dem Deploy mit
pip install -r requirements.txtin einer neuen Umgebung
🚀 Nächste Schritte
Wenn deinerequirements.txt-Datei konfiguriert ist:
- Committe sie in dein Git-Repository.
- Hoste dein Projekt auf Square Cloud.
- Richte automatischen Deploy über GitHub ein.
- Willkommen beim professionellen Hosting von Python-Anwendungen!
requirements.txt-Datei ist die Grundlage für jede erfolgreiche Python-Anwendung und stellt sicher, dass deine Anwendung auf Square Cloud einwandfrei funktioniert.