Introduction¶

Setup¶

プロジェクトは、newコマンドを使用してHatchで使用するように設定できます。

New project¶

Hatch Demoという名前のプロジェクトを作成するとします。次のコマンドを実行します。:

hatch new "Hatch Demo"

これにより、現在の作業ディレクトリに次の構造が作成されます。:

hatch-demo
├── src
│   └── hatch_demo
│       ├── __about__.py
│       └── __init__.py
├── tests
│   └── __init__.py
├── LICENSE.txt
├── README.md
└── pyproject.toml

Existing project¶

既存のプロジェクトを初期化するには、プロジェクトが格納されているディレクトリを入力し、次のコマンドを実行します。:

hatch new --init

プロジェクトにsetup.pyファイルがある場合、このコマンドは自動的にsetuptoolsの設定を移行します。それ以外の場合は、セットアッププロセスをインタラクティブにガイドします。

Project metadata¶

次に、pyproject.tomlファイルにあるプロジェクトのmetadataをさらに定義します。license、supported versions of Python、URLなど、プロジェクトのさまざまな部分(ドキュメントなど)を参照するものを指定できます。

Dependencies¶

セットアッププロセスの最後のステップは、プロジェクトを開始したいdependenciesを定義することです。

Configuration¶

Hatchによって認識されるすべてのプロジェクト固有の構成は、pyproject.tomlファイル、またはtool.hatchテーブル内にオプションが含まれていないhatch.tomlという名前のファイルのいずれかで定義できます。:

[tool.hatch]
option = "..."

[tool.hatch.table1]
option = "..."

[tool.hatch.table2]
option = "..."

option = "..."

[table1]
option = "..."

[table2]
option = "..."

両方で定義されている場合、後者のファイルの最上位レベルのキーが優先されます。

[tool.hatch]
option = "..."
table1.option = "..."
table2.option = "..."

option = "..."
table1.option = "..."
table2.option = "..."