django-boss

django-sjefen er en implementering av ideene som er skissert i mitt blogginnlegg på Django ledelse kommandoer. Med det kan du angi kommandoer i enkelte apps og deretter kjøre dem ved hjelp av djboss kommandolinjegrensesnitt.
Installere django-sjef
For øyeblikket er installasjonen gjøres via easy_install django-sjefen eller PIP installere django-sjefen. De eneste forutsetningene er argparse, hvis installasjonen er håndtert av setuptools, og Django, som du bør ha installert nå uansett.
Skrive Kommandoer
Kommandoer er definert som forekomster av djboss.commands.Command, til stede i et kommandoer submodule inne en installert app. For eksempel ta følgende app layout:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
Den commands.py filen er en submodule som kan importeres som echoapp.commands.
Med dekoratører
Følgende er en komplett eksempel på et gyldig commands.py fil:
fra djboss.commands importere *
command
def hallo (args):
& Nbsp; "" "Skriv ut en klisjé til konsollen." ""
& Nbsp; print "Hello, World!"
Dette eksemplet brukercommand dekoratør å erklære at funksjonen er en django-sjef kommandoen. Du kan legge til argumenter på kommandoer også; bare brukeargument dekoratør (sørge for at de kommer ettercommand):
command
argument ('- n', 'no-linjeskift ", action =' store_true ',
& Nbsp; help = "Ikke legge en avsluttende linjeskift.")
def hallo (args):
& Nbsp; "" "Skriv ut en klisjé til konsollen." ""
& Nbsp; hvis args.no_newline:
& nbsp; import sys
& Nbsp; sys.stdout.write ("Hei, verden»)
& Nbsp; annet:
& Nbsp; print "Hello, World!"
Denargument dekoratør godtar uansett argparse.ArgumentParser.add_argument () gjør; konsultere argparse docs for mer informasjon.
Du kan også kommentere kommandoer ved å gi søkeord argumenter for åcommand:
command (name = "noe", beskrivelse = "gjør noe".)
def do_something (args):
& Nbsp; "" ". Gjør noe" ""
& Nbsp; print "noe har blitt gjort."
I dette tilfellet vil kommandoen bli kalt "noe" i stedet for auto-genererte "gjør-noe", og beskrivelsen vil være forskjellig fra sin docstring. For mer informasjon om hva som kan sendes inn her, konsultere argparse.ArgumentParser docs.
Uten dekoratører
API er veldig lik uten dekoratører. Kommando klassen brukes til å pakke inn funksjoner, og du kan gi søkeord argumenter når påkalle den som medcommand:
def ekko (args):
& Nbsp; ...
echo = Kommando (ekko, name = '...', beskrivelse = "...")
Legge argumenter bruker den Command.add_argument () metoden, som er bare en referanse til det genererte sub-parser & rsquo; s add_argument () metoden:
def ekko (args):
& Nbsp; ...
echo = Kommando (ekko, name = '...', beskrivelse = "...")
echo.add_argument ('- n', 'no-linjeskift ", ...)
echo.add_argument ('ord', nargs = '*')
Kjøre kommandoer
Kommandoene utføres via djboss kommandolinjegrensesnitt. For at dette skal fungere, trenger du en av to ting:
* En DJANGO_SETTINGS_MODULE miljøvariabel som viser til en gyldig, import Python-modul.
* En gyldig, importmodulen i innstillingene i gjeldende arbeidskatalog.
Når en av dem er dekket, kan du kjøre det:
djboss --help
bruk: djboss [-h] [-v] [-l LEVEL] COMMAND ...
Kjør django-sjefen ledelse kommandoer.
valgfrie argumenter:
& Nbsp; h, help vis denne hjelpemeldingen og exit
& Nbsp; -V, --version viser programmets versjonsnummer og exit
& Nbsp; -l LEVEL, --log-nivå LEVEL
& Nbsp; Velg et loggnivået fra DEBUG, INFO, WARN (standard)
& Nbsp; eller FEIL.
kommandoer:
& Nbsp; COMMAND
& Nbsp; echo Echo argumentene tilbake til konsollen.
& Nbsp; hallo Skriv en klisjé til konsollen.
Å oppdage underkommandoer, djboss første funn og import dine Django innstillinger.
Den DJANGO_SETTINGS_MODULE miljøvariabelen forrang, men hvis uspesifisert, vil djboss se etter en `settings` modul i gjeldende katalog. Kommandoer bør defineres i en `commands` submodule av hver app. djboss vil søke hver av dine INSTALLED_APPS for ledelse kommandoer.
Hver -delkommandoen får help alternativ også:
djboss ekko --help
bruk: djboss ekko [h] [-n] [ord [ord ...]]
Ekko argumentene tilbake til konsollen.
posisjonelle argumenter:
& nbsp; ord
valgfrie argumenter:
& Nbsp; h, help vis denne hjelpemeldingen og exit
& Nbsp; n, Do no-newline ikke skrive ut et linjeskift etterpå.
Og så kan du kjøre den:
djboss ekko noen ord her
noen ord her
Mer av det samme:
djboss hallo --help
bruk: djboss hei [-h]
Skriv ut en klisjé til konsollen.
valgfrie argumenter:
& Nbsp; h, help vis denne hjelpemeldingen og exit
Og til slutt:
djboss hallo
Hei, Verden

Krav

• Django
• Python