django clite

django-clite

Una herramienta CLI que maneja la creación y administración de proyectos de Django

• django-clite
  • Instalación
    • Extendiendo el CLI
  • Dependencias
  • Documentos interactivos
  • Hacer
  • Solicitud de solicitud
  • LICENCIA

Instalación

Instalar a través de PIP:

pip install django-clite

Después de la instalación, la CLI expondrá el binario con el nombre:

 django-clite

Extendiendo el CLI

Actualmente, hay dos formas principales de extender la funcionalidad de la CLI:

1. Agregar sus propios comandos/complementos
2. Anular las plantillas de recursos proporcionadas

Incluyendo sus propios comandos

Si desea extender la funcionalidad de esta CLI, puede incluir sus propios plugins/commands estableciendo una variable de entorno: DJANGO_CLITE_PLUGINS . Simplemente establezca esta variable en la ruta donde están sus complementos.

Los comandos de complementos se descubren automáticamente si se colocan en el directorio de complementos, pero asegúrese de hacer lo siguiente para que esto funcione:

1. Nombra su paquete y haga clic en Comando de la misma manera . Es decir, un paquete llamado get , por ejemplo, debería definir un comando get .
2. Coloque la definición de comando dentro del módulo main.py del paquete . Por ejemplo:

 # get/main.py
import click


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

3. Se deben agregar sub comandos al grupo de comando más alto en el módulo main.py del paquete.

 # 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. Acceda a sus comandos a través de su grupo de comandos superior.

 django-clite get foo

Nota: Si desea omitir un complemento/comando de ser descubierto automáticamente, simplemente cambie el nombre del paquete prependiendo o agregando cualquier cantidad de subrayos ( _ ). Cualquier código contenido en el paquete será ignorado.

Anulación de las plantillas

El flag --templates-dir se puede usar para configurar una ruta adicional en la que la CLI puede buscar plantillas de recursos. Alternativamente, puede usar la variable de entorno DJANGO_CLITE_TEMPLATES_DIR para el mismo propósito.

Eche un vistazo al directorio de archivos de plantilla para obtener una referencia de qué archivos se pueden anular. Las rutas de las plantillas que desea anular necesitan coincidir con la plantilla proporcionada. Por ejemplo, si desea anular la plantilla del modelo, que se define en src/cli/template_files/models/model.tpl , debe definir su propia plantilla de modelo en su directorio deseado, es decir, IE /path/to/templates/models/model.tpl .

Desarrollo

Instalar desde la fuente:

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

Dependencias

Echa un vistazo a PyProject.toml para todas las dependencias de instalación.

Documentos interactivos

Para mantener la consistencia en nuestra documentación de todos los diferentes comandos y características de la CLI, hemos decidido mover el ReadMe a una serie de cuadernos Jupyter que puede explorar por comando en el directorio DOCS.

Hacer

Mira nuestros problemas abiertos.

Solicitud de solicitud

Encontrado un error? ¿Ves un error tipográfico? ¿Tiene una idea para el nuevo comando? No dude en enviar una solicitud de extracción con sus contribuciones. Son muy bienvenidos y apreciados.

LICENCIA

Django-Clite tiene licencia BSD.