So packen Sie ein Befehlszeilen-Python-Skript

Python ist eine leistungsstarke Programmiersprache, die in der Welt der Softwareentwicklung vielfältige Anwendung findet und sehr weit verbreitet ist. Mit Python können wir verschiedene Arten von Anwendungen erstellen. Wir können auch ein CLI-Skript in Python erstellen, mit dem viele Aufgaben automatisiert werden können. Wir können dann auch das CLI-Skript packen.

Damit diese Skripte von anderen verwendet werden können, müssen wir diese Anwendungen verpacken und verteilen. Wir müssen also wissen, wie wir ein Befehlszeilen-Python-Skript packen können. Dieser Artikel führt Sie durch alle Schritte, die zum Packen eines Python-Skripts erforderlich sind, und macht es Ihnen sehr einfach, selbst ein Skript zu packen.

Wir müssen die folgenden Schritte ausführen, um ein Befehlszeilenskript oder CLI-Skript in Python zu packen.

Schritt 1: Erforderliche Bibliotheken installieren

Wir müssen alle erforderlichen Python-Bibliotheken installieren, bevor wir mit dem Skript beginnen können. Die Datei „requirements.txt“ enthält alle erforderlichen Bibliotheken für das Befehlszeilenskript, das Sie erstellen möchten. Diese Bibliotheken sind nicht festgelegt und ändern sich je nach den Anforderungen des Skripts. Führen Sie zur Installation den folgenden Befehl aus

pip install -r requirements.txt

Dieser Befehl installiert alle erforderlichen Bibliotheken und ihre Abhängigkeiten, die in der Datei „requirements.txt“ aufgeführt sind.

Schritt 2: Erstellen Sie eine virtuelle Umgebung

Im zweiten Schritt müssen wir eine virtuelle Umgebung erstellen, die alle für das Projekt benötigten Bibliotheken sowie die Abhängigkeiten für dieses Projekt enthält. Wir erstellen eine virtuelle Umgebung, um sicherzustellen, dass das Projekt beim Packen und Entwickeln einwandfrei funktioniert. Wir werden den folgenden Befehl verwenden, um eine virtuelle Umgebung zu erstellen

python3 -m venv env

Dieser Befehl erstellt eine neue virtuelle Umgebung im .env-Verzeichnis.

Schritt 3: Aktivieren Sie die virtuelle Umgebung

Nachdem die virtuelle Umgebung erstellt wurde, müssen wir sie aktivieren. Wir werden diesen Befehl unten verwenden, um es zu aktivieren −

source env/bin/activate

Der obige Befehl aktiviert die zuvor erstellte virtuelle Umgebung und alle von Ihnen installierten Bibliotheken oder Abhängigkeiten werden auch in der virtuellen Umgebung installiert.

Schritt 4: Erstellen Sie das Setup-Skript

Der nächste Schritt besteht darin, ein Setup-Skript zu erstellen. Ein Setup-Skript ist ein Python-Skript, das das Paket beschreibt, das Sie erstellen möchten. Es enthält Informationen wie den Paketnamen, die Version, den Autor und andere Metadaten. Hier ist ein Beispiel-Setup-Skript:

from setuptools import setup, find_packages
setup(
   name='mycommand',
   version='0.1',
   author='Your Name',
   author_email='your@email.com',
   description='My Command Line Tool',
   packages=find_packages(),
   entry_points={
      'console_scripts': [
         'mycommand=mycommand.cli:main',
      ],
   },
)

Wir haben die Setup-Tools-Bibliothek von Python verwendet, um das Paket zu erstellen. Im obigen Code haben wir den Namen unseres Pakets zusammen mit dem Versionsautor und verschiedenen anderen Metadaten definiert. Wir haben auch den Einstiegspunkt für das Skript definiert, d. h. den Punkt, von dem aus die Ausführung des Pakets beginnt, nämlich die Datei cli.py.

Schritt 5: Erstellen Sie das CLI-Skript

Der fünfte Schritt ist die Erstellung eines Command Line Interface-Skripts oder CLI-Skripts. Dieses Skript hat die Hauptfunktion, die das Skript ausführen muss. Dieses Skript wird ausgeführt, wenn es über die Befehlszeile aufgerufen wird. Unten finden Sie ein einfaches Beispiel

def main():
   print('Hello, World!')

Im obigen Skript haben wir einfach eine Hauptfunktion erstellt, die bei ihrer Ausführung „Hallo Welt“ ausgibt. Dies ist unsere Hauptfunktion, die ausgeführt werden muss, wenn wir die CLI-Anwendung aufrufen.

Schritt 6: Erstellen Sie das Paket

Nachdem Sie das Setup-Skript und das CLI-Skript erstellt haben, können Sie das Paket mit dem folgenden Befehl erstellen:

python setup.py sdist bdist_wheel

Dieser Befehl erstellt eine Quelldistribution und eine Binärdistribution Ihres Pakets. Die Quelldistribution enthält den Quellcode für Ihr Paket und die Binärdistribution enthält eine kompilierte Version Ihres Pakets.

Schritt 7: Verteilen Sie das Paket

Nachdem wir das Paket erstellt haben, müssen wir es nun verteilen, damit andere Entwickler oder Programmierer es verwenden können. Wir können die Verteilung einfach mit dem Paketmanager von Python, PyPI, durchführen. Wir können das Paket auch manuell für Benutzer freigeben, indem wir einfach die erstellte Paketdatei über Google Drive oder eine andere Medienfreigabeplattform an den Endbenutzer senden.

Schritt 8: Installieren und testen Sie das Paket

Wir sollten das Paket zum Testen auf unserem System installieren. Wir können dieses Paket mit pip installieren, einem Paketinstallationsprogramm für Python. Wir werden den folgenden Befehl verwenden, um das Paket zu installieren

pip install mycommand-0.1-py3-none-any.whl

Dadurch wird das Paket erfolgreich auf unserem System installiert. Wir können dieses Paket jetzt auch testen, indem wir den folgenden Befehl ausführen:

mycommand

Dieser Befehl führt die Hauptfunktion in der Datei cli.py aus und gibt „Hello, World!“ aus. zur Konsole.

Abschluss

In diesem Artikel haben wir verstanden, wie wir ein in Python geschriebenes Befehlszeilenskript packen können. Wir haben alle Schritte durchlaufen, die zum Verpacken der Anwendung erforderlich waren. Nachdem Sie alle Schritte in diesem Artikel befolgt haben, können Sie ganz einfach Ihr eigenes Befehlszeilenskript packen, das Abhängigkeiten und Metadaten enthält. Das von Ihnen erstellte Paket kann problemlos auch an Benutzer verteilt werden, indem Sie sie freigeben oder PyPI verwenden.