django clite

Django-clite

Uma ferramenta da CLI que lida com a criação e gerenciamento de projetos de Django

• Django-clite
  • Instalação
    • Estendendo a CLI
  • Dependências
  • Documentos interativos
  • Pendência
  • Puxar solicitações
  • LICENÇA

Instalação

Instale via PIP:

pip install django-clite

Após a instalação, a CLI exporá o binário com o nome:

 django-clite

Estendendo a CLI

Atualmente, existem duas maneiras principais de estender a funcionalidade da CLI:

1. Adicionando seus próprios comandos/plugins
2. Substituindo os modelos de recursos fornecidos

Incluindo seus próprios comandos

Se você deseja estender a funcionalidade desta CLI, pode incluir seus próprios plugins/commands definindo uma variável de ambiente: DJANGO_CLITE_PLUGINS . Basta definir essa variável para o caminho onde estão seus plugins.

Os comandos do plug-in são descobertos automaticamente se forem colocados no diretório do plugins, mas não se esqueça de fazer o seguinte para que isso funcione:

1. Nomeie seu pacote e clique em comando o mesmo . Ou seja, um pacote chamado get , por exemplo, deve definir um comando get .
2. Coloque a definição de comando no módulo main.py do pacote . Por exemplo:

 # get/main.py
import click


@ click . command ()
@ click . pass_context
def get ( ctx ):
    pass

3. Os subcomandos devem ser adicionados ao grupo de comando mais importante no módulo main.py do pacote.

 # get/main.py
import click


@ click . group () # <- group
@ click . pass_context
def get ( ctx ):
  pass


@ click . command ()
@ click . pass_context
def foo ( ctx ):
  pass


get . add_command ( foo )

4. Acesse seus comandos através do seu grupo de comando mais importante.

 django-clite get foo

NOTA: Se você deseja pular um plug-in/comando de ser descoberto automático, basta renomear o pacote, antecendendo ou anexando qualquer número de sublinhados ( _ ). Qualquer código contido no pacote será ignorado.

Substituindo os modelos

A bandeira --templates-dir pode ser usada para configurar um caminho adicional no qual a CLI pode procurar modelos de recursos. Como alternativa, você pode usar a variável de ambiente DJANGO_CLITE_TEMPLATES_DIR para o mesmo objetivo.

Dê uma olhada no diretório de arquivos de modelo para obter uma referência de quais arquivos podem ser substituídos. Os caminhos dos modelos que você deseja substituir precisam corresponder ao modelo fornecido. Por exemplo, se você deseja substituir o modelo do modelo, definido em src/cli/template_files/models/model.tpl , você deve definir seu próprio modelo de modelo no diretório desejado, ou seja, /path/to/templates/models/model.tpl .

Desenvolvimento

Instale da fonte:

 git clone https://github.com/oleoneto/django-clite.git
cd django-clite
pip install --editable .

Dependências

Confira PyProject.toml para todas as dependências de instalação.

Documentos interativos

Para manter a consistência em nossa documentação de todos os diferentes comandos e recursos da CLI, decidimos mudar o ReadMe para uma série de notebooks Jupyter que você pode explorar por comando no diretório Docs.

Pendência

Confira nossos problemas abertos.

Puxar solicitações

Encontrou um bug? Veja um erro de digitação? Tem uma ideia para um novo comando? Sinta -se à vontade para enviar uma solicitação de tração com suas contribuições. Eles são muito bem -vindos e apreciados.

LICENÇA

Django-clite é licenciado em BSD.