django-boss

Django-chef er en implementering af de idéer, der er skitseret i min blog-indlæg på Django management kommandoer. Med det, kan du angive kommandoer i de enkelte apps og derefter køre dem ved hjælp af djboss kommando-line interface.
Installation Django-boss
I øjeblikket er installationen sker via easy_install Django-chef eller pip installere Django-chef. De eneste forudsætninger er argparse, hvis installation varetages af setuptools og Django, som du bør have installeret nu alligevel.
Skrivning Kommandoer
Kommandoer er defineret som forekomster af djboss.commands.Command, der er til stede i en kommandoerne submodule inde en installeret app. For eksempel tage følgende app layout:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
Den commands.py fil er en undermodul, der kan importeres som echoapp.commands.
Med Dekoratører
Følgende er en komplet eksempel på et gyldigt commands.py fil:
fra djboss.commands importerer *
command
def hej (args):
& Nbsp; "" "Udskriv en kliché til konsollen." ""
& Nbsp; print "Hello, World!"
Dette eksempel brugercommand dekoratør til at erklære, at funktionen er en Django-boss kommando. Du kan tilføje argumenter til kommandoer også; bare brugeargument dekoratør (sørg for at de kommer eftercommand):
command
argument ('- n', '--no-newline', action = 'store_true',
& Nbsp; help = "Du skal ikke tilføje en afsluttende linjeskift.")
def hej (args):
& Nbsp; "" "Udskriv en kliché til konsollen." ""
& Nbsp; hvis args.no_newline:
& nbsp; import sys
& Nbsp; sys.stdout.write ("! Hello, World")
& Nbsp; andet:
& Nbsp; print "Hello, World!"
Denargument dekoratør accepterer hvad argparse.ArgumentParser.add_argument () gør; høre de argparse docs for mere information.
Du kan også anmærke kommandoer ved at give søgeord argumenter for atcommand:
command (name = "noget", beskrivelse = "Er noget.")
def do_something (args):
& Nbsp; "" ". Gør noget" ""
& Nbsp; print "noget er blevet gjort."
I dette tilfælde vil kommandoen hedde "noget" i stedet for auto-genererede "gør-noget", og dens beskrivelse vil afvige fra sin docstrengen. For mere information om, hvad der kan videregives i her, høre argparse.ArgumentParser docs.
Uden Dekoratører
API er meget ens uden dekoratører. Kommando klasse bruges til at ombryde funktioner, og du kan give søgeord argumenter, når påberåbe det som medcommand:
def echo (args):
& Nbsp; ...
echo = Kommando (ekko, name = '...', beskrivelse = '...')
Tilføjelse argumenter bruger den Command.add_argument () metode, som er blot en reference til den genererede sub-parser & rsquo; s add_argument () metode:
def echo (args):
& Nbsp; ...
echo = Kommando (ekko, name = '...', beskrivelse = '...')
echo.add_argument ('- n', '--no-newline «, ...)
echo.add_argument ('ordene », nargs =' * ')
Løb Kommandoer
Kommandoer udføres via djboss kommando-line interface. For at dette kan køre korrekt, du har brug for en af ​​to ting:
* En DJANGO_SETTINGS_MODULE miljøvariabel som henviser til en gyldig, kan indføres Python modul.
* En gyldig, kan indføres indstillinger modul i den aktuelle arbejdsmappe.
Når en af ​​dem er dækket, kan du køre det:
djboss --help
forbrug: djboss [-h] [-v] [-l LEVEL] COMMAND ...
Kør Django-boss management-kommandoer.
valgfri argumenter:
& Nbsp; -h, --help vis denne hjælp besked og exit
& Nbsp; -v, --version viser programmets versionsnummer og afslut
& Nbsp; -l NIVEAU, --log niveau NIVEAU
& Nbsp; Vælg en log-niveau fra DEBUG, INFO, WARN (standard)
& Nbsp; eller fejl.
kommandoer:
& Nbsp; COMMAND
& Nbsp; echo Echo argumenterne tilbage til konsollen.
& Nbsp; hej Udskriv en kliché til konsollen.
At opdage sub-kommandoer, djboss første fund og import dine Django indstillinger.
Variablen DJANGO_SETTINGS_MODULE miljø forrang, men hvis uspecificeret, vil djboss kigge efter en `settings` modul i det aktuelle bibliotek. Kommandoer bør defineres i en `commands` undermodul af hver app. djboss vil søge hver af dine INSTALLED_APPS for ledelse kommandoer.
Hver underkommandoen får en --help indstilling også:
djboss echo --help
brug: djboss ekko [-h] [-n] [ord [ord ...]]
Echo argumenterne tilbage til konsollen.
positionelle argumenter:
& nbsp; ord
valgfri argumenter:
& Nbsp; -h, --help vis denne hjælp besked og exit
& Nbsp; -n, Må --no-newline ikke udskrive en ny linje bagefter.
Og så kan du køre det:
djboss echo nogle ord her
nogle ord her
Mere af det samme:
djboss hej --help
forbrug: djboss hej [-h]
Udskriv en kliché til konsollen.
valgfri argumenter:
& Nbsp; -h, --help vis denne hjælp besked og exit
Og endelig:
djboss hej
! Hej, World

Krav :

• Django
• Python