django-boss

django-chefen är en implementering av de idéer som beskrivs i mitt blogginlägg på Django hanteringskommandon. Med den kan du ange kommandon i enskilda program och sedan köra dem med djboss kommandoradsgränssnittet.
Installera django-chef
Just nu, är installationen görs via easy_install django-chef eller PIP installera django-chef. De enda förutsättningarna är argparse, vars installation hanteras av setuptools, och Django, som du bör ha installerat vid det här laget ändå.
Skriva kommandon
Kommandon definieras som fall av djboss.commands.Command, som förekommer i en kommandon submodul inuti en installerad app. Ta till exempel följande appen layout:
echoapp /
| - __init__.py
| - Commands.py
'- Models.py
Den commands.py filen är en submodul som kan importeras som echoapp.commands.
Med dekoratörer
Följande är en komplett exempel på en giltig commands.py fil:
från djboss.commands importera *
command
def hej (args):
& Nbsp; "" "Skriv ut en klyscha till konsolen." ""
& Nbsp; print "Hello, World!"
Detta exempel användercommand dekoratör att förklara att funktionen är en django-boss kommando. Du kan lägga till argument på kommandon också; bara användaargument dekoratör (se till att de kommer eftercommand):
command
argument ("- n ',' --no-nyrad", action = 'store_true "
& Nbsp; hjälp = "Do not bifoga en avslutande nyrad.")
def hej (args):
& Nbsp; "" "Skriv ut en klyscha till konsolen." ""
& Nbsp; om args.no_newline:
& nbsp; import sys
& Nbsp; sys.stdout.write ("Hej, Världen")
& Nbsp; annan:
& Nbsp; print "Hello, World!"
Denargument dekoratör accepterar vad argparse.ArgumentParser.add_argument () gör; samråda med argparse docs för mer information.
Du kan också kommentera kommandon genom att ge sökords argument för attcommand:
command (name = "något", description = "Gör något.")
def do_something (args):
& Nbsp; "" ". Gör något" ""
& Nbsp; print "något har gjorts."
I detta fall kommer kommandot att kallas "något" i stället för automatiskt genererade "gör-någonting", och dess beskrivning kommer att skilja sig från sin docstring. För mer information om vad som kan föras in här, konsultera argparse.ArgumentParser docs.
Utan Decorators
API är mycket lik utan dekoratörer. Kommando klassen används för att svepa funktioner, och du kan ge sökords argument när de åberopar den som medcommand:
def echo (args):
& Nbsp; ...
echo = Kommando (eko, name = '...', description = '...')
Lägga argument använder den) metoden Command.add_argument (vilket är bara en hänvisning till den genererade under parser & rsquo; s add_argument) metoden (:
def echo (args):
& Nbsp; ...
echo = Kommando (eko, name = '...', description = '...')
echo.add_argument ('- n', '--no-nyrad', ...)
echo.add_argument ("ord", nargs = '*')
Running kommandon
Kommandon exekveras via djboss kommandoradsgränssnittet. För att detta ska fungera, måste du en av två saker:
* En DJANGO_SETTINGS_MODULE miljövariabel som hänför sig till en giltig, importe Python modul.
* En giltig, importeras inställningar modul i den aktuella arbetskatalogen.
När en av dem är täckt, kan du köra det:
djboss help
användning: djboss [-h] [-v] [-l LEVEL] COMMAND ...
Kör django-chef hanteringskommandon.
valfria argument:
& Nbsp; -h, --help visa denna hjälpmeddelande och avsluta
& Nbsp; -v, --version visar programmets versionsnummer och avsluta
& Nbsp; -l NIVÅ, --log-nivå NIVÅ
& Nbsp; Välj en loggnivån från DEBUG, INFO, varna (standard)
& Nbsp; eller FEL.
kommandon:
& Nbsp; COMMAND
& Nbsp; echo Echo argumenten tillbaka till konsolen.
& Nbsp; hej Skriv en klyscha till konsolen.
Att upptäcka underkommandon, djboss första fynd och import dina Django inställningar.
Den DJANGO_SETTINGS_MODULE miljövariabeln har företräde, men om ospecificerad kommer djboss leta efter en `settings` modul i den aktuella katalogen. Kommandon bör definieras i en `commands` submodul av varje app. djboss kommer att söka alla dina INSTALLED_APPS för hanteringskommandon.
Varje underkommandot får en --help alternativ också:
djboss eko help
användnings: djboss echo [-h] [-n] [ord [ord ...]]
Echo argumenten tillbaka till konsolen.
positionella argument
& nbsp; ord
valfria argument:
& Nbsp; -h, --help visa denna hjälpmeddelande och avsluta
& Nbsp; -n, Do --no-newline inte ut en ny rad efteråt.
Och då kan du köra det:
djboss upprepa några ord här
några ord här
Mer av samma:
djboss hej --help
användning: djboss hej [-h]
Skriv en klyscha till konsolen.
valfria argument:
& Nbsp; -h, --help visa denna hjälpmeddelande och avsluta
Och slutligen:
djboss hej
Hej, World

Krav :

• Django
• Python