django clite

Django-Clite

Un outil CLI qui gère la création et la gestion de projets Django

• Django-Clite
  • Installation
    • Prolonger la CLI
  • Dépendances
  • Docs interactifs
  • Faire
  • Des demandes de traction
  • LICENCE

Installation

Installer via PIP:

pip install django-clite

Après l'installation, la CLI exposera le binaire avec le nom:

 django-clite

Prolonger la CLI

Actuellement, il existe deux façons principales d'étendre la fonctionnalité de la CLI:

1. Ajout de vos propres commandes / plugins
2. Remplir les modèles de ressources fournies

Y compris vos propres commandes

Si vous souhaitez étendre les fonctionnalités de cette CLI, vous pouvez inclure vos propres plugins/commands en définissant une variable d'environnement: DJANGO_CLITE_PLUGINS . Définissez simplement cette variable sur le chemin où se trouvent vos plugins.

Les commandes de plugin sont découvertes automatiquement si elles sont placées sous le répertoire des plugins, mais assurez-vous de faire ce qui suit pour que cela fonctionne:

1. Nommez votre package et cliquez sur la commande de la même manière . Autrement dit, un package appelé get , par exemple, devrait définir une commande get .
2. Placez la définition de commande dans le module main.py du package . Par exemple:

 # get/main.py
import click


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

3. Les sous-communs doivent être ajoutés au groupe de commandes le plus élevé dans le module main.py du package.

 # 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. Accédez à vos commandes via votre groupe de commandes le plus élevé.

 django-clite get foo

Remarque: Si vous souhaitez passer un plugin / commande en étant automatiquement découvert, renommez simplement le package en ajoutant ou en ajoutant n'importe quel nombre de soulignements ( _ ). Tout code contenu dans le package sera ignoré.

Overniter les modèles

L'indicateur --templates-dir peut être utilisé pour configurer un chemin supplémentaire dans lequel la CLI peut rechercher des modèles de ressources. Alternativement, vous pouvez utiliser la variable d'environnement DJANGO_CLITE_TEMPLATES_DIR dans le même but.

Jetez un œil au répertoire des fichiers de modèle pour une référence de quels fichiers peuvent être remplacés. Les chemins des modèles que vous souhaitez remplacer doivent correspondre au modèle fourni. Par exemple, si vous souhaitez remplacer le modèle de modèle, qui est défini sous src/cli/template_files/models/model.tpl , vous devez définir votre propre modèle de modèle sous votre répertoire souhaité, ie /path/to/templates/models/model.tpl .

Développement

Installation à partir de la source:

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

Dépendances

Consultez PyProject.toml pour toutes les dépendances d'installation.

Docs interactifs

Afin de maintenir la cohérence dans notre documentation de toutes les différentes commandes et fonctionnalités de la CLI, nous avons décidé de déplacer la lecture vers une série de cahiers Jupyter que vous pouvez explorer par commande sous le répertoire DOCS.

Faire

Découvrez nos problèmes ouverts.

Des demandes de traction

Vous avez trouvé un bug? Vous voyez une faute de frappe? Vous avez une idée pour une nouvelle commande? N'hésitez pas à soumettre une demande de traction avec vos contributions. Ils sont très bienvenus et appréciés.

LICENCE

Django-Clite est sous licence BSD.