Setuptools ist ein unverzichtbares Werkzeug für Python-Entwickler. Es bietet viele Funktionen, die den Entwicklungs- und Distributionsprozess von Python-Projekten viel einfacher und bequemer machen. In diesem ausführlichen Handbuch werden wir uns mit den grundlegenden Funktionen von Setuptools vertraut machen und erfahren, wie Sie sie richtig verwenden können, um Ihre Projekte effektiv zu verwalten.
Setuptools bietet eine automatisierte Abhängigkeitsverwaltung, mit der Sie leicht die benötigten Bibliotheken und Versionen angeben können, die für die Ausführung Ihres Projekts erforderlich sind. Außerdem können Sie Installationspakete erstellen, die einfach verteilt und auf anderen Computern installiert werden können, ohne jede Abhängigkeit manuell installieren zu müssen.
Darüber hinaus bietet Setuptools die Möglichkeit, Erweiterungen für vorhandene Pakete zu erstellen und sie in andere Entwicklungstools wie Paketsammler und Versionskontrollsysteme zu integrieren. Damit können Sie benutzerfreundliche Befehlszeilenschnittstellen für Ihre Projekte erstellen, Versionen und Änderungen am Code verwalten und viele Routineaufgaben automatisieren.
Installieren von Python-Setuptools
Bevor Sie mit den Python-Setuptools beginnen, müssen Sie es auf Ihrem System installieren. In diesem Abschnitt werden wir einige Möglichkeiten zur Installation von Python-Setuptools untersuchen.
Installation mit pip
Die Python-Setuptools können mit dem Pip - Batch- Manager für die Programmiersprache Python installiert werden. Pip bietet eine einfache und bequeme Möglichkeit, verschiedene Python-Pakete und -Bibliotheken zu installieren.
Um Python-Setuptools mit pip zu installieren, öffnen Sie ein Terminal oder eine Eingabeaufforderung und führen Sie den folgenden Befehl aus:
| pip install setuptools |
Nach dem Ausführen des Befehls wird pip die Python-Setuptools und alle seine Abhängigkeiten auf Ihrem System installieren. Bei Bedarf aktualisiert pip auch die bereits installierten Pakete.
Installation mit easy_install
Eine weitere Möglichkeit, Python-Setuptools zu installieren, ist die Verwendung des Dienstprogramms easy_install, das auch mit Python geliefert wird. Easy_install ermöglicht die Installation von Python-Paketen aus verschiedenen Quellen.
Um Python-Setuptools mit easy_install zu installieren, öffnen Sie ein Terminal oder eine Eingabeaufforderung und führen Sie den folgenden Befehl aus:
| easy_install setuptools |
Nach dem Ausführen des Befehls easy_install Setuptools wird Python auf Ihrem System installiert. Easy_install kann bei Bedarf auch bereits installierte Pakete aktualisieren.
Überprüfen der Installation
Um zu überprüfen, ob die Python-Setuptools erfolgreich auf Ihrem System installiert sind, führen Sie den folgenden Befehl im Terminal oder in der Befehlszeile aus:
| python -m setuptools --version |
Wenn Python Setuptools korrekt installiert ist, wird die Version des installierten Pakets angezeigt.
Nachdem Python Setuptools nun erfolgreich auf Ihrem System installiert wurde, können Sie damit beginnen, andere Python-Pakete zu installieren und zu verwalten. Im nächsten Abschnitt werden wir die grundlegenden Funktionen und Funktionen von Python-Setuptools untersuchen.
Installieren und Konfigurieren der Entwicklungsumgebung
Um mit Python-Setuptools zu arbeiten, benötigen Sie eine angepasste Entwicklungsumgebung. In diesem Abschnitt werden wir uns mit der Installation und Konfiguration der erforderlichen Tools befassen.
Schritt 1: Installieren von Python
Der erste Schritt ist, Python auf Ihrem Computer zu installieren. Python ist eine Programmiersprache, auf der Setuptools ausgeführt wird. Sie können das Python-Installationsprogramm von der offiziellen Python-Website herunterladen und den Installationsanweisungen für Ihr Betriebssystem folgen.
Schritt 2: Installieren und Konfigurieren von pip
Nach der Installation von Python müssen Sie auch das Pip-Tool installieren und konfigurieren. Pip ist ein Paketmanager für Python, mit dem Bibliotheken und Abhängigkeiten von Drittanbietern einfach installiert werden können.
- Öffnen Sie eine Eingabeaufforderung oder ein Terminal
- Geben Sie den folgenden Befehl ein, um pip zu installieren: python -m ensurepip --default-pip
- Stellen Sie nach der Installation von pip sicher, dass der Pfad zur ausführbaren pip-Datei zu den Systemumgebungsvariablen hinzugefügt wird.
Schritt 3: Installieren und Konfigurieren von Setuptools
Jetzt müssen Sie Setuptools installieren und konfigurieren. Setuptools ist eine Bibliothek, mit der Sie die Installation und Verwaltung von Python-Paketen vereinfachen können.
- Öffnen Sie eine Eingabeaufforderung oder ein Terminal
- Geben Sie den folgenden Befehl ein, um Setuptools zu installieren: pip install setuptools
- Nachdem Sie Setuptools installiert haben, können Sie überprüfen, ob es erfolgreich installiert wurde, indem Sie den folgenden Befehl eingeben: easy_install --version
Glückwunsch! Sie haben die Entwicklungsumgebung erfolgreich für die Arbeit mit Python-Setuptools installiert und konfiguriert. Jetzt sind Sie bereit, mit dem Erstellen und Verwalten von Python-Paketen mit Setuptools zu beginnen.
Erstellen und Verwalten eines Projekts mit Setuptools
Um mit Setuptools zu beginnen, müssen Sie eine Datei erstellen setup.py im Stammverzeichnis Ihres Projekts. In dieser Datei geben Sie die grundlegenden Projektparameter wie Titel, Version, Autor und Beschreibung an.
Beispieldatei setup.py:
from setuptools import setupsetup(name='my_project',version='1.0',author='John Doe',description='My project description',packages=['my_package'],install_requires=['numpy', 'matplotlib'])
In diesem Beispiel geben wir den Projektnamen an (name), Version (version), Autors (author) und Beschreibung (description). Außerdem geben wir an, welche Pakete in das Projekt aufgenommen werden sollen (packages) und welche Abhängigkeiten müssen vor dem Ausführen des Projekts installiert werden (install_requires).
Nachdem die Datei erstellt wurde setup.py sie können den Befehl verwenden python setup.py install um das Projekt und seine Abhängigkeiten zu installieren.
Mit Setuptools können Sie auch eine Distribution für Ihr Projekt erstellen, die Sie an andere Benutzer verteilen können. Verwenden Sie dazu den Befehl python setup.py sdist, die ein Archiv mit dem Quellcode Ihres Projekts erstellt.
Die Projektabhängigkeiten werden mithilfe einer Datei verwaltet requirements.txt. In dieser Datei listen Sie alle Projektabhängigkeiten mit jeweils einer neuen Zeile auf.
Beispieldatei requirements.txt:
numpymatplotlib
So installieren Sie Abhängigkeiten aus einer Datei requirements.txt verwenden Sie den Befehl pip install -r requirements.txt.
Setuptools bietet viele andere Möglichkeiten zum Verwalten von Projekten: das Erstellen von ausführbaren Dateien, die Unterstützung von Erweiterungen und vieles mehr. Weitere Informationen finden Sie in der Dokumentation zu Setuptools.
Verwenden von Setuptools zum Festlegen von Abhängigkeiten
Um Setuptools zum Installieren von Abhängigkeiten zu verwenden, müssen Sie eine Datei mit dem Namen erstellen requirements.txt und listet alle Abhängigkeiten auf, die für Ihr Projekt erforderlich sind. Jede Abhängigkeit muss in einer separaten Zeile mit dem Paketnamen und der Version angegeben werden (falls erforderlich).
Ein Beispiel für den Inhalt einer requirements-Datei.txt:
numpy==1.19.5pandas==1.1.5matplotlib==3.3.4
Nachdem Sie die requirements-Datei erstellt haben.txt und eine Liste von Abhängigkeiten darin enthalten, können Sie das Setuptools-Tool verwenden, um alle Pakete automatisch zu installieren. Dazu benötigen Sie den Befehl pip install -r requirements.txt. Wenn Sie diesen Befehl ausführen, liest Setuptools die requirements-Datei.txt installiert automatisch alle angegebenen Pakete und ihre Abhängigkeiten.
Setuptools unterstützt auch verschiedene andere Methoden zum Festlegen von Abhängigkeiten, z. B. die Verwendung einer Datei setup.py oder Integration mit Paketverwaltungstools wie pipenv oder venv. Die Verwendung von requirements ist jedoch erforderlich.txt ist die gebräuchlichste und einfachste Methode zum Installieren von Abhängigkeiten mit Setuptools.
Mit Setuptools zum Installieren von Abhängigkeiten können Sie die Bibliotheken und Module Ihres Projekts einfach verwalten und aktualisieren und sicherstellen, dass sie auf anderen Rechnern verfügbar sind, ohne dass eine manuelle Installation erforderlich ist. Dies macht den Projektentwicklungs- und Bereitstellungsprozess effizienter und bequemer.
Konfigurieren und Verteilen eines Pakets mit Setuptools
In diesem Abschnitt werden die grundlegenden Schritte zum Konfigurieren und Verteilen eines Pakets mit Setuptools erläutert.
1. Erstellen einer Projektstruktur
Der erste Schritt beim Einrichten eines Pakets besteht darin, eine Projektstruktur zu erstellen. Es wird empfohlen, alle Projektdateien in einem separaten Verzeichnis zu speichern. Im Stammverzeichnis dieses Verzeichnisses sollte sich eine Datei befinden setup.py , die von Setuptools zum Konfigurieren des Pakets verwendet wird.
Die Projektstruktur könnte ungefähr so aussehen:
my_package/ setup.py my_package/ __init__.py module1.py module2.py .
2. Datei schreiben setup.py
Setup-Datei.py ist die zentrale Datei in der Paketkonfiguration mit Setuptools. In dieser Datei geben Sie Metadaten zu Ihrem Paket an, z. B. Titel, Version, Autor und Abhängigkeiten. Außerdem können Sie die Skripte und Daten angeben, die im Installationsprogramm des Pakets enthalten sein sollen.
Beispieldatei setup.py:
from setuptools import setup setup( name='my_package', version='1.0', author='John Doe', packages=['my_package'], install_requires=[ 'dependency1', 'dependency2', ], scripts=['script.py'], package_data=< 'my_package': ['data/*.txt'], >, )
3. Installieren von Setuptools
Bevor Sie Setuptools verwenden können, müssen Sie es installieren. Setuptools kann mit dem folgenden Befehl pip installiert werden:
pip install setuptools
4. Erstellen eines Installationsprogramms
Wenn eine Datei vorhanden ist setup.py und die Setuptools installiert haben, können Sie ein Paketinstallationsprogramm erstellen. Führen Sie dazu den folgenden Befehl an einer Eingabeaufforderung aus:
python setup.py sdist
Dieser Befehl erstellt ein Archiv mit den Quelldateien Ihres Projekts, das zum Installieren des Pakets verwendet wird.
5. Paket verteilen
Nachdem Sie das Installationsprogramm erstellt haben, können Sie Ihr Paket an andere Benutzer verteilen. Sie können ein Paket verteilen, indem Sie es beispielsweise auf der PyPI-Plattform veröffentlichen oder ein eigenes Paket-Repository erstellen.
Wenn Sie ein Paket auf PyPI veröffentlichen möchten, müssen Sie sich zuerst auf der Plattform registrieren und die Anmeldeinformationen für den API-Zugriff erhalten. Sie können Ihr Paket dann veröffentlichen, indem Sie den folgenden Befehl ausführen:
python setup.py upload
Nachdem das Paket erfolgreich veröffentlicht wurde, können andere Benutzer es mit dem folgenden Befehl mit pip installieren:
pip install my_package
Schlußfolgerung
Setuptools bietet leistungsstarke Funktionen zum Konfigurieren und Verteilen von Paketen in Python. In diesem Abschnitt haben wir die grundlegenden Schritte zum Konfigurieren und Verteilen eines Pakets mit Setuptools behandelt. Jetzt können Sie Ihre eigenen Pakete erstellen und sie mit anderen Python-Benutzern teilen.