django clite

Django-Clite

Djangoプロジェクトの作成と管理を処理するCLIツール

• Django-Clite
  • インストール
    • CLIを拡張します
  • 依存関係
  • インタラクティブドキュメント
  • やる
  • リクエストをプルします
  • ライセンス

インストール

PIP経由でインストール：

pip install django-clite

インストール後、CLIは次の名前でバイナリを公開します。

 django-clite

CLIを拡張します

現在、CLIの機能を拡張する主な方法は2つあります。

1. 独自のコマンド/プラグインを追加します
2. 提供されたリソーステンプレートをオーバーライドします

あなた自身のコマンドを含む

このCLIの機能を拡張したい場合は、環境変数DJANGO_CLITE_PLUGINSを設定して、独自のplugins/commandsを含めることができます。この変数をプラグインがあるパスに設定するだけです。

プラグインコマンドは、プラグインディレクトリの下に配置されている場合に自動発見されますが、これを実行するには、次のことを確認してください。

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のすべての異なるコマンドと機能のドキュメントの一貫性を維持するために、docsディレクトリの下でコマンドごとに調査できる一連のJupyterノートブックにReadMeを移動することにしました。

やる

オープンな問題をご覧ください。

リクエストをプルします

バグを見つけましたか？タイプミスを見る？新しいコマンドのアイデアがありますか？あなたの貢献でプルリクエストをお気軽に送信してください。彼らは大歓迎で感謝しています。

ライセンス

Django-CliteはBSDライセンスです。