Hatchを知る#

私たちの Python パッケージングチュートリアルは Hatch というツールを使っています。 世の中には たくさんの素晴らしいパッケージングツール があります、私たちはHatchを選ぶ理由は:

  1. 高品質なPythonパッケージを作成するために必要なステップのほとんどをサポートするエンドツーエンドのツールです。Hatchを使えば、初心者は覚えるツールが少なくて済みます。

  2. 他の言語のコードをコンパイルする必要がある場合は、異なるビルドバックエンドをサポートします。

  3. コミュニティとして、pyOpenSciはHatchが多くの異なる科学的なPythonの使用例をサポートするユーザーフレンドリーなツールであると決定しました。

このチュートリアルでは、Hatchをインストールし、使い始める前にもう少しHatchについて知ってもらいます。

このチュートリアルを成功させるために必要なものは2つあります:

  1. Pythonがインストールされている必要があります。

  2. Hatchをインストールする必要があります。

重要

Pythonがまだインストールされていない場合は、Hatchをインストールする際にPythonがインストールされます。

Hatchのインストール#

まず、以下のオペレーティングシステム別の説明に従ってHatchをインストールしてください。

こちら の指示に従ってください。

  • MAC用最新GUIインストーラー hatch-universal.pkg をダウンロードしてください。

  • インストーラーを実行し、セットアップ手順に従ってください。

  • ターミナルが開いている場合は、再起動してください。

  • ブラウザで、お使いのシステムに合った .msi ファイルをダウンロードしてください: hatch-x64.msi

  • ダウンロードしたインストーラーファイルを実行し、画面の指示に従ってください。

Linux上ではpipxを使用してHatchをインストールすることをお勧めしますが、他の方法をご希望の場合は、 Hatchのインストールドキュメント をご覧ください。

# First install pipx
> apt install pipx
# Then install hatch using pipx
> pipx install hatch

Tip

Hatchは pip や conda を使って直接インストールすることもできる。WindowsとMac用のHatchインストーラーが最も簡単で効率的であることがわかりましたので、上記の指示に従うことをお勧めします。

私たちのLinuxユーザーは、すでにapt installを使っている場合、pipxを使ってHatchをインストールすることに成功しています。

どちらのアプローチ（Windows/Macでグラフィカルインストーラを使う方法とpipxを使う方法）も、Hatchがグローバルにインストールされていることを保証します。 グローバルインストールとは、コンピュータ上の全てのPython環境でHatchが利用できることを意味します。

hatchが正しく取り付けられているか確認します#

上記のインストール手順が完了したら、ターミナルを開き、以下のコマンドを使用してHatchが正しくインストールされたことを確認してください:

hatch --version
# Hatch, version 1.9.4

Note the version number output of hatch --version will likely be different from the output above in this tutorial.

Hatchの設定#

Hatchをインストールしたら、その設定をカスタマイズすることができます。 これには、作成するすべてのパッケージにデフォルト名とセットアップを設定することも含まれます。 このステップは必須ではありませんが、行うことをお勧めします。

Hatchは設定を config.tomlファイル に保存します。

コマンドラインから config.toml ファイルを更新することができます, 初めて使う場合は、テキストエディタで見て更新する方が簡単かもしれません。

ステップ 1: config.toml ファイルを開いて編集する#

ファイルブラウザで設定ファイルを開くには、シェルで以下のコマンドを実行します:

hatch config explore

ディレクトリウィンドウが開き、ファイルをダブルクリックして好きなテキストエディタで開くことができます。

シェルで以下のコマンドを実行すれば、Hatchのコンフィグファイルの場所を取得することもできます:

hatch config find
# hatch config --help will show you all the options for config.

ステップ2 - Eメールと名前を更新する#

ファイルを開いたら、 config.toml ファイルの[template]テーブルをあなたの名前とEメールで更新します。 この情報は、Hatchを使用して作成した pyproject.toml メタデータファイルに使用されます。

[template]
name = "firstName LastName"
email = "your-email@your-domain.org"

ステップ3#

次に、 [template.plugins.default] テーブルでtestsをfalseに設定します。

テストは重要ですが、Hatchのtests設定を true にすると、より複雑な pyproject.toml ファイルが作成されます。この初心者向けチュートリアルシリーズではこの機能を使う必要はありませんが、後のチュートリアルで紹介します。

あなたの config.toml ファイルは以下のようになるはずです。

mode = "local"
project = ""
shell = ""

[dirs]
project = []
python = "isolated"
data = "/Users/your/path/Application Support/hatch"
cache = "/Users/your/path/Library/Caches/hatch"

[dirs.env]

[projects]

[publish.index]
repo = "main"

[template]
name = "Leah Wasser"
email = "leah@pyopensci.org"

[template.licenses]
headers = true
default = [
    "MIT",
]

[template.plugins.default]
tests = false
ci = false
src-layout = true

[terminal.styles]

また、デフォルトのライセンスオプションがMITであることにも注目してください。 ライセンスについては後のレッスンで詳しく説明しますが、 MITライセンスは choosealicense.com が推奨する寛容なライセンスです、そしてこのチュートリアルシリーズではこれを使用します。

もちろん、他のライセンスを選択することも歓迎します。

ステップ4: 設定ファイルを閉じて、 hatch config show を実行します。#

上記の手順が完了したら、シェルで以下のコマンドを実行します。

hatch config show

hatch config show はシェルの config.toml ファイルの内容を出力します。 値を見て、あなたの名前とEメールが設定されていることを確認してください。また、 tests=false であることを確認すること。

Hatchの特徴#

Hatchは、Pythonパッケージの作成、公開、保守を容易にする一連の機能を提供します。

他のツールとの比較

私たちはHatchを、flit、pdm、poetryなど、エコシステムで人気のある他のパッケージングツールと比較しました。 詳細はこちら

Hatchの詳細はこちら

Hatchが提供するいくつかの機能

  1. これは setup.py または setup.cfg ファイルに保存されたメタデータを pyproject.toml ファイルに変換します。 (Hatchを使用してsetup.pyをpyproject.tomlに移行する を参照)

  2. PyPIに公開するための設定情報を、一度入力した後に保存してくれます。

利用可能なコマンドをすべて表示するには、 hatch -h を使用します。

次のレッスン#

次のレッスンでは、Hatchを使ってコードをパッケージ化し、インストール可能にする方法を学びます。