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許可。