django-boss

django-jefe es una implementación de las ideas esbozadas en mi blog sobre los comandos de administración de Django. Con él, usted puede especificar comandos en aplicaciones individuales y luego ejecutarlos mediante la interfaz de línea de comandos djboss.
Instalación django-jefe
Por el momento, la instalación se realiza a través easy_install django-jefe o PIP instalar django-jefe. Los únicos requisitos son argparse, cuya instalación está a cargo de setuptools, y Django, lo que usted debe haber instalado por ahora de todos modos.
Comandos de escritura
Los comandos se definen como casos de djboss.commands.Command, presentes en un submódulo comandos dentro de una aplicación instalada. Por ejemplo, tomemos la siguiente distribución de aplicaciones:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
El archivo commands.py es un submódulo que se puede importar como echoapp.commands.
Con Decoradores
El siguiente es un ejemplo completo de un archivo commands.py válida:
desde djboss.commands importar *
Command
def hola (args):
& Nbsp; "" "Imprimir un cliché a la consola." ""
& Nbsp; print "Hola, mundo!"
Este ejemplo utiliza el decoradorCommand para declarar que la función es un comando django-jefe. Usted puede agregar argumentos a los comandos también; sólo tiene que utilizar el decoradorargument (asegúrese de que vienen después de que el comando deCommand):
Command
argument ('- n', '--no-nueva línea', action = 'store_true',
& Nbsp; help = "No anexar una nueva línea de salida.")
def hola (args):
& Nbsp; "" "Imprimir un cliché a la consola." ""
& Nbsp; si args.no_newline:
& nbsp; import sys
& Nbsp; sys.stdout.write ("¡Hola, mundo")
& Nbsp; otra cosa:
& Nbsp; print "Hola, mundo!"
El decoradorargument acepta lo argparse.ArgumentParser.add_argument () hace; consulte la documentación argparse para más información.
También puede anotar comandos dando argumentos de palabras clave paraCommand:
Command (name = "algo", description = "haga algo".)
hacer_algo def (args):
& Nbsp; "" ". Hacer algo" ""
& Nbsp; print "algo se ha hecho."
En este caso, el comando se llamará "algo" en lugar del "algo hacer" generada automáticamente, y su descripción será diferente de su cadena de documentación. Para obtener más información sobre lo que puede pasar aquí, consulte la documentación argparse.ArgumentParser.
Sin Decoradores
El API es muy similar sin decoradores. La clase de comando se utiliza para envolver funciones, y le puede dar argumentos de palabra clave cuando se invoca como conCommand:
def eco (args):
& Nbsp; ...
echo = Comando (eco, name = "...", description = '...')
Adición de argumentos utiliza el método Command.add_argument (), que es sólo una referencia a la sub-parser y rsquo generada; s add_argument método ():
def eco (args):
& Nbsp; ...
echo = Comando (eco, name = "...", description = '...')
echo.add_argument ('- n', '--no-nueva línea', ...)
echo.add_argument ("palabras", nargs = '*')
Ejecución de comandos
Los comandos se ejecutan a través de la interfaz de línea de comandos djboss. Por esta para funcionar correctamente, necesita una de dos cosas:
* Una variable de entorno DJANGO_SETTINGS_MODULE que se refiere a un módulo de Python válida, importables.
* Un módulo válida, la configuración de importables en el directorio de trabajo actual.
Una vez que uno de esos está cubierta, se puede ejecutar:
djboss --help
uso: djboss [-h] [-v] [NIVEL -l] COMANDO ...
Ejecutar comandos de administración de Django-jefe.
argumentos opcionales:
& Nbsp; -h, --help muestra este mensaje de ayuda y sale
& Nbsp; -v, número de versión --version show de programa y salir
& Nbsp; NIVEL -l, NIVEL nivel --log
& Nbsp; Elegir un nivel de registro de DEBUG, INFO, WARN (por defecto)
& Nbsp; o ERROR.
comandos:
& Nbsp; COMANDO
& Nbsp; echo eco de los argumentos de nuevo a la consola.
& Nbsp; hola Imprimir un cliché a la consola.
Para descubrir los sub-comandos, djboss primeros hallazgos y las importaciones de sus ajustes de Django.
La variable de entorno DJANGO_SETTINGS_MODULE tiene prioridad, pero si no se especifica, djboss buscará un módulo `Settings` en el directorio actual. Los comandos se deben definir en un `submódulo commands` de cada aplicación. djboss buscará cada uno de sus INSTALLED_APPS de comandos de administración.
Cada subcomando obtiene una opción --help también:
djboss eco --help
de uso: djboss eco [-h] [-n] [palabras [palabras ...]]
Eco de los argumentos de nuevo a la consola.
argumentos posicionales:
& nbsp; palabras
argumentos opcionales:
& Nbsp; -h, --help muestra este mensaje de ayuda y sale
& Nbsp; -n, --no-salto de línea No imprima una nueva línea después.
Y entonces se puede ejecutar:
djboss eco de unas palabras aquí
algunas palabras aquí
Más de lo mismo:
djboss hola --help
uso: djboss hola [-h]
Imprimir un cliché a la consola.
argumentos opcionales:
& Nbsp; -h, --help muestra este mensaje de ayuda y sale
Y finalmente:
djboss hola
! Hola, mundo

Requisitos

• Django
• Python