django-boss

django-chefe é uma implementação das ideias expostas no meu blog sobre comandos de gerenciamento de Django. Com ele, você pode especificar comandos em aplicativos individuais e, em seguida, executá-los usando a interface de linha de comando djboss.
Instalação django-chefe
No momento, a instalação é feita através easy_install django-chefe ou pip instalar django-chefe. Os únicos pré-requisitos são argparse, cuja instalação é tratada pelo setuptools, e Django, que você deve ter instalado por agora de qualquer maneira.
Escrita Comandos
Os comandos são definidos como casos de djboss.commands.Command, presentes em um sub-módulo comandos dentro de um aplicativo instalado. Por exemplo, ter o seguinte layout app:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
O arquivo commands.py é um sub-módulo que pode ser importado como echoapp.commands.
Com Decoradores
O que se segue é um exemplo completo de um arquivo commands.py válido:
de djboss.commands importar *
command
def Olá (args):
& Nbsp; "" "Imprimir um clichê para o console." ""
& Nbsp; print "Olá, mundo!"
Este exemplo usa o decoradorcommand para declarar que a função é um comando django-chefe. Você pode adicionar argumentos para comandos também; basta usar o decoradorargument (certifique-se que eles vêm após o comando @):
command
argument ('- n', '--no-nova linha', action = "store_true ',
& Nbsp; help = "Não acrescente uma nova linha de fuga.")
def Olá (args):
& Nbsp; "" "Imprimir um clichê para o console." ""
& Nbsp; se args.no_newline:
& nbsp; import sys
& Nbsp; sys.stdout.write ("Olá, mundo")
& Nbsp; mais:
& Nbsp; print "Olá, mundo!"
O decoradorargument aceita tudo argparse.ArgumentParser.add_argument () faz; consultar os docs argparse para mais informações.
Você também pode anotar comandos, dando argumentos nomeados paraCommand:
command (name = "algo", description = "Será que alguma coisa.")
do_something def (args):
& Nbsp; "" ". Faça alguma coisa" ""
& Nbsp; print "algo foi feito."
Neste caso, o comando será chamado de "algo" em vez do "faça algo" gerado automaticamente, e sua descrição será diferente de sua docstring. Para obter mais informações sobre o que pode ser passado aqui, consultar os docs argparse.ArgumentParser.
Sem Decoradores
A API é muito semelhante sem decoradores. A classe Command é usado para envolver funções, e você pode dar argumentos de palavra-chave ao chamar-lo como comcommand:
def eco (args):
& Nbsp; ...
echo = Command (eco, name = '...', description = '...')
Adicionando argumentos usa o método Command.add_argument (), que é apenas uma referência para o sub-parser & rsquo gerado; s add_argument) método (:
def eco (args):
& Nbsp; ...
echo = Command (eco, name = '...', description = '...')
echo.add_argument ('- n', '--no-nova linha', ...)
echo.add_argument ('palavras', nargs = '*')
Executando Comandos
Os comandos são executados por meio da interface de linha de comando djboss. Para que isso funcionar corretamente, você precisa de uma de duas coisas:
* A variável de ambiente DJANGO_SETTINGS_MODULE que se refere a um módulo Python importable válido.
* A, módulo de configuração válida importáveis ​​no diretório de trabalho atual.
Uma vez que um desses é coberto, você pode executá-lo:
djboss --help
uso: djboss [-h] [-v] [NÍVEL -l] COMMAND ...
Executar comandos de gerenciamento de django-chefe.
argumentos opcionais:
& Nbsp; -h, --help mostrar esta mensagem de ajuda e sai
& Nbsp; -v, --version mostra o número da versão do programa e sai
& Nbsp; NÍVEL -l, --log-level LEVEL
& Nbsp; Escolha um nível de log de debug, info, WARN (padrão)
& Nbsp; ou erro.
Comandos:
& Nbsp; COMMAND
& Nbsp; echo echo os argumentos de volta para o console.
& Nbsp; Olá Imprimir um clichê para o console.
Para descobrir sub-comandos, djboss primeiros achados e importações configurações do Django.
A variável de ambiente DJANGO_SETTINGS_MODULE tem prioridade, mas se não especificado, djboss irá procurar um módulo `Settings` no diretório atual. Os comandos devem ser definidos em um `submodule commands` de cada app. djboss irá procurar cada uma de suas INSTALLED_APPS para comandos de gerenciamento.
Cada subcomando recebe uma opção --help também:
djboss eco --help
uso: djboss eco [-h] [-n] [palavras [palavras ...]]
Ecoam os argumentos de volta para o console.
argumentos posicionais:
& nbsp; palavras
argumentos opcionais:
& Nbsp; -h, --help mostrar esta mensagem de ajuda e sai
& Nbsp; -n, --no-nova linha Não imprimir uma nova linha depois.
E então você pode executá-lo:
djboss ecoam algumas palavras aqui
algumas palavras aqui
Mais do mesmo:
djboss Olá --help
uso: djboss Olá [-h]
Imprimir um clichê para o console.
argumentos opcionais:
& Nbsp; -h, --help mostrar esta mensagem de ajuda e sai
E finalmente:
Olá djboss
! Olá, mundo

Requisitos :

• Django
• Python