django clite

django-clite

CLI工具，可以处理创建和管理Django项目

• django-clite
  • 安装
    • 扩展CLI
  • 依赖性
  • 互动文档
  • 做
  • 拉请求
  • 执照

安装

通过PIP安装：

pip install django-clite

安装后，CLI将以名称公开二进制文件：

 django-clite

扩展CLI

当前，扩展CLI功能的主要方法有两种：

1. 添加您自己的命令/插件
2. 覆盖提供的资源模板

包括你自己的命令

如果您想扩展此CLI的功能，则可以通过设置环境变量来包含自己的plugins/commands ： DJANGO_CLITE_PLUGINS 。只需将此变量设置为插件所在的路径即可。

如果插件命令将其放置在插件目录下，则将自动发现它们，但请确保为此做以下操作：

1. 命名您的软件包，然后单击命令相同。也就是说，例如，称为get的软件包应定义一个get命令。
2. 将命令定义放置在软件包的main.py模块中。例如：

 # get/main.py
import click


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

3. 应将子命令添加到软件包的main.py模块中的最高命令组中。

 # 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. 通过您的最高命令组访问您的命令。

 django-clite get foo

注意：如果您想从自动发现的自动发现中跳过插件/命令，只需通过预处理或附加任何数量的下划线（ _ ）来重命名软件包。软件包中包含的任何代码将被忽略。

覆盖模板

标志--templates-dir可用于配置CLI可以查找资源模板的其他路径。另外，您可以将环境变量DJANGO_CLITE_TEMPLATES_DIR用于相同的目的。

查看模板文件目录，以引用可以超越哪些文件。您希望覆盖的模板的路径需要匹配提供的模板。例如，如果您希望覆盖模型模板，该模型模板是在src/cli/template_files/models/model.tpl下定义的，则应在所需的目录中定义自己的模型模板，即/path/to/templates/models/model.tpl 。

发展

从来源安装：

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

依赖性

查看所有安装依赖性的pyproject.toml。

互动文档

为了在我们对CLI的所有不同命令和功能的文档中保持一致性，我们决定将ReadMe移至一系列Jupyter笔记本电脑，您可以根据文档目录探索每个命令。

做

查看我们的公开问题。

拉请求

找到一个错误？看到错字吗？有新命令的想法吗？随时提交您的贡献请求。他们非常欢迎和赞赏。

执照

Django-Clite已获得BSD许可。