django clite

Django-Clite

Ein CLI -Tool, das das Erstellen und Verwalten von Django -Projekten übernimmt

• Django-Clite
  • Installation
    • Erweiterung der CLI
  • Abhängigkeiten
  • Interaktive Dokumente
  • Zu tun
  • Anfragen ziehen
  • LIZENZ

Installation

Installieren Sie über PIP:

pip install django-clite

Nach der Installation wird die CLI die Binärdatei mit dem Namen freilegen:

 django-clite

Erweiterung der CLI

Derzeit gibt es zwei Hauptmethoden, um die Funktionalität der CLI zu erweitern:

1. Hinzufügen Ihrer eigenen Befehle/Plugins
2. Überschreiben der bereitgestellten Ressourcenvorlagen

Einschließlich Ihrer eigenen Befehle

Wenn Sie die Funktionalität dieser CLI erweitern möchten, können Sie Ihre eigenen plugins/commands einfügen, indem Sie eine Umgebungsvariable festlegen: DJANGO_CLITE_PLUGINS . Stellen Sie diese Variable einfach auf den Pfad ein, in dem sich Ihre Plugins befinden.

Plugin-Befehle werden automatisch entdeckt, wenn sie unter das Plugins-Verzeichnis platziert werden. Bitte beachten Sie, dass dies funktioniert, damit dies funktioniert:

1. Nennen Sie Ihr Paket und klicken Sie auf den Befehl gleich . Das heißt, ein Paket namens get zum Beispiel sollte einen Befehl get definieren.
2. Platzieren Sie die Befehlsdefinition im main.py des Pakets . Zum Beispiel:

 # get/main.py
import click


@ click . command ()
@ click . pass_context
def get ( ctx ):
    pass

3. Unter-Commands sollten der obersten Befehlsgruppe im main.py des Pakets hinzugefügt werden.

 # get/main.py
import click


@ click . group () # <- group
@ click . pass_context
def get ( ctx ):
  pass


@ click . command ()
@ click . pass_context
def foo ( ctx ):
  pass


get . add_command ( foo )

4. Greifen Sie über Ihre oberste Befehlsgruppe auf Ihre Befehle zu.

 django-clite get foo

Hinweis: Wenn Sie einen Plugin/Befehl aus überspringen möchten, wenn Sie automatisch entdeckt werden, benennen Sie das Paket einfach um, indem Sie eine beliebige Anzahl von Unterstrichen ( _ ) vorbereiten oder anhängen. Jeder im Paket enthaltene Code wird ignoriert.

Die Vorlagen überschreiben

Das Flag --templates-dir kann verwendet werden, um einen zusätzlichen Pfad zu konfigurieren, in dem die CLI nach Ressourcenvorlagen suchen kann. Alternativ können Sie die Umgebungsvariable DJANGO_CLITE_TEMPLATES_DIR für denselben Zweck verwenden.

Schauen Sie sich das Verzeichnis der Vorlagendateien an, um eine Referenz zu erhalten, auf welche Dateien überschrieben werden können. Die Pfade der Vorlagen, die Sie überschreiben möchten, müssen mit der bereitgestellten Vorlage übereinstimmen. Wenn Sie beispielsweise die Modellvorlage überschreiben möchten, die unter src/cli/template_files/models/model.tpl definiert ist, sollten Sie Ihre eigene Modellvorlage unter Ihrem gewünschten Verzeichnis, dh /path/to/templates/models/model.tpl templates/models/model.tpl, definieren.

Entwicklung

Aus Quelle installieren:

 git clone https://github.com/oleoneto/django-clite.git
cd django-clite
pip install --editable .

Abhängigkeiten

Schauen Sie sich pyproject.toml für alle Installationsabhängigkeiten an.

Interaktive Dokumente

Um die Konsistenz in unserer Dokumentation aller verschiedenen Befehle und Merkmale der CLI aufrechtzuerhalten, haben wir beschlossen, die Readme in eine Reihe von Jupyter -Notizbüchern zu verschieben, die Sie im DOCS -Verzeichnis pro Befehl untersuchen können.

Zu tun

Schauen Sie sich unsere offenen Probleme an.

Anfragen ziehen

Einen Fehler gefunden? Einen Tippfehler sehen? Haben Sie eine Idee für einen neuen Befehl? Fühlen Sie sich frei, eine Pull -Anfrage bei Ihren Beiträgen einzureichen. Sie sind sehr willkommen und geschätzt.

LIZENZ

Django-Clite ist BSD lizenziert.