django-boss

django-Chef ist eine Implementierung der in meinem Blog-Post auf Django Verwaltungsbefehle skizzierten Ideen. Mit ihm können Sie Befehle in einzelnen Anwendungen festlegen, und führen Sie sie mit der djboss Befehlszeilenschnittstelle.
Installieren django-Chef
Im Moment wird die Installation über easy_install django-Chef oder getan pip django-Chef zu installieren. Die einzigen Voraussetzungen sind argparse, dessen Installation wird von Setuptools behandelt, und Django, die man sich jetzt sowieso installiert haben.
Writing Befehle
Befehle werden als Instanzen der djboss.commands.Command, in einem Modul Befehle innerhalb einer installierten App vorliegenden definiert. Nehmen wir zum Beispiel das folgende App Layout:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
Die commands.py Datei ist ein Teilmodul, das als echoapp.commands importiert werden kann.
Mit Tape
Hier finden Sie eine vollständige Beispiel für eine gültige commands.py Datei:
von djboss.commands importieren *
Befehl
def hallo (args):
& Nbsp; "" "senden Klischee an die Konsole." ""
& Nbsp; print "Hallo Welt!"
Dieses Beispiel verwendet dieBefehl Dekorateur zu erklären, dass die Funktion eine Django-Chef Befehl. Sie können Argumente an Befehle zu fügen; benutzen Sie einfach dieargument Dekorateur (sicherzustellen, dass sie nach dem @ Befehl kommen):
Befehl
argument ('- n', '--no-Zeilenumbruch ", action =' store_true ',
& Nbsp; help = "Sie hängen Sie nicht eine Hinterzeilenumbruch".)
def hallo (args):
& Nbsp; "" "senden Klischee an die Konsole." ""
& Nbsp; wenn args.no_newline:
& Nbsp; import sys
& Nbsp; sys.stdout.write ("Hallo, Welt")
& Nbsp; sonst:
& Nbsp; print "Hallo Welt!"
Dieargument Dekorateur nimmt, was argparse.ArgumentParser.add_argument () macht; finden Sie in den argparse docs für weitere Informationen.
Sie können auch Befehle Anmerkungen zu versehen, indem Schlüsselwort-Argumente, um @ Befehl:
@ Befehl (name = "etwas", description = "etwas tut.")
def do_something (args):
& Nbsp; "" ". Tun Sie etwas" ""
& Nbsp; print "etwas getan worden ist."
In diesem Fall wird der Befehl "etwas" anstelle des automatisch generierten "do-irgendwas" genannt werden, und ihre Beschreibung wird von seinem docstring abweichen. Für weitere Informationen über das, was können Sie hier übergeben werden, finden Sie in den argparse.ArgumentParser docs.
Ohne Dekorateure
Die API ist sehr ähnlich, ohne Dekorateure. Das Command-Klasse wird verwendet, um Funktionen zu wickeln, und Sie Schlüsselwort-Argumente geben kann beim Aufruf als mitBefehl:
def echo (args):
& Nbsp; ...
echo = Befehl (echo, name = '...', description = '...')
Hinzufügen Argumente verwendet die () -Methode Command.add_argument, die nur ein Verweis auf das erzeugte Unter Parser & rsquo ist; s add_argument () Methode:
def echo (args):
& Nbsp; ...
echo = Befehl (echo, name = '...', description = '...')
echo.add_argument ('- n', '--no-Zeilenumbruch', ...)
echo.add_argument ("Worte", nargs = '*')
Ausführen von Befehlen
Befehle werden über die djboss Befehlszeilenschnittstelle ausgeführt. Damit dies korrekt ausführen, müssen Sie eines von zwei Dingen:
* A DJANGO_SETTINGS_MODULE Umgebungsvariable, die auf eine gültige, import Python-Modul bezieht.
* Eine gültige, import Einstellungen Modul im aktuellen Arbeitsverzeichnis.
Sobald einer von denen, bedeckt ist, können Sie es ausführen:
djboss --help
Nutzung: djboss [-h] [-v] [-l LEVEL] COMMAND ...
Führen django-Chef Verwaltungsbefehle.
optionale Argumente:
& Nbsp; -h, --help diese Hilfe und beende zeigen
& Nbsp; -v, Versionsnummer und Ausfahrt --version Show-Programm
& Nbsp; -l LEVEL, --log-level LEVEL
& Nbsp; Wählen Sie eine Protokollstufe von DEBUG, INFO, WARN (default)
& Nbsp; oder ERROR.
Befehle:
& Nbsp; COMMAND
& Nbsp; echo Echo die Argumente zurück auf die Konsole.
& Nbsp; hallo senden Klischee an die Konsole.
Sub-Kommandos, djboss ersten Funde und die Einfuhr Ihrer Django-Einstellungen zu entdecken.
Die DJANGO_SETTINGS_MODULE Umgebungsvariable hat Vorrang, aber wenn nicht spezifiziert, wird djboss für eine `Einstellungen` Modul im aktuellen Verzeichnis zu suchen. Befehle sollten in einem `commands` Submodul jedes app definiert werden. djboss wird jede Ihrer INSTALLED_APPS für Verwaltungsbefehle zu suchen.
Jeder Unterbefehl erhält eine Option --help zu:
djboss echo --help
Nutzung: djboss echo [-h] [-n] [words [Worten ...]]
Echo die Argumente zurück auf die Konsole.
Positionsargumente:
& Nbsp; Wörter
optionale Argumente:
& Nbsp; -h, --help diese Hilfe und beende zeigen
& Nbsp; -n, --no-newline Sie eine neue Zeile danach ausdrucken nicht.
Und dann können Sie ihn ausführen:
djboss ein paar Worte hier echo
hier ein paar Worte
Mehr vom Gleichen:
djboss hallo --help
Nutzung: djboss hallo [-h]
Senden Klischee an die Konsole.
optionale Argumente:
& Nbsp; -h, --help diese Hilfe und beende zeigen
Und schlussendlich:
djboss hallo
Hallo Welt!

Anforderungen :

• Django
• Python