基本的な使い方

blueprintpyのCLI blueprint について、付属のデフォルトテンプレートを展開する例を示します。

このテンプレートでは、pipコマンドでインストール可能なPythonパッケージの最小構成を生成することができます。

注釈

デフォルトテンプレートで展開される内容は予告なく変更される可能性があり、 ドキュメントに反映されるまで時間がかかることがあります。 展開されるテンプレートの内容は blueprintpy.internal_templates モジュールを確認してください。

1. プロジェクトルートの生成

プロジェクトのルートとなるディレクトリを作成します。

mkdir project_test

プロジェクトディレクトリに移動し、 blueprint コマンドを実行します。

cd project_test
blueprint . --name default

コマンドの構文は以下の通りです。

blueprint 展開先ディレクトリパス --name テンプレート名

(blueprint --help を実行することで、より詳細なヘルプを閲覧できます。)

なお、展開先ディレクトリパスおよびテンプレート名は省略することができます。展開先を省略した場合は現在のディレクトリに、テンプレート名を省略した場合は default が設定されます。

(つまり、今回の場合は単純に blueprint とするだけでも問題はありません)

コマンドを実行すると、以下のパラメータを設定するよう求められます。

プロジェクト名 (project_name)

プロジェクトの説明 (project_descripiton)

ライセンス (license)

依存関係パッケージ (dependencies)

依存関係パッケージについては、EOF(Ctrl+D)が入力されるまで値を追加することができます。

設定されたパラメータの値をもとにテンプレートが展開され、所定の場所に配置されます。完了後のディレクトリ構成は以下のようになります:

.
├── README.md
├── mypy.ini
├── setup.cfg
├── setup.py
└── src
    └── project_example
        └── __init__.py