Configuring project metadata¶

プロジェクトのメタデータは、プロジェクトのツリーのルートにあるpyproject.tomlファイルに保存されます。

完全にthe standardに基づいています。

Name (required)¶

プロジェクトの名前。

[project]
name = "your-app"

Version (required)¶

[project]
...
dynamic = ["version"]

[tool.hatch.version]
path = "..."

[project]
...
version = "0.0.1"

Description¶

プロジェクトの簡単な概要

[project]
...
description = '...'

Readme¶

プロジェクトの完全な説明。

[project]
...
readme = "README.md"

[project]
...
readme = {"file" = "README.md", "content-type" = "text/markdown"}

[project]
...
readme = {"text" = "...", "content-type" = "text/markdown"}

Python support¶

プロジェクトのPythonバージョン要件。

[project]
...
requires-python = ">=3.8"

License¶

詳細はPEP 639を参照のこと。

[project]
...
license = "Apache-2.0 OR MIT"

[project]
...
license-files = { paths = ["LICENSE.txt"] }

[project]
...
license-files = { globs = ["LICENSES/*"] }

Ownership¶

プロジェクトのauthors またはmaintainersと見なされる人または組織。

正確な意味は解釈の余地があります。元の作成者または主な作成者、現在のメンテナ、またはパッケージの所有者をリストすることができます。値が同じ場合は、authorsフィールドのみを使用することをお勧めします。

[project]
...
authors = [
  { name = "...", email = "..." },
]
maintainers = [
  { name = "...", email = "..." },
]

Keywords¶

プロジェクトの発見を支援するために使用されるキーワード。

[project]
...
keywords = [
  "...",
]

Classifiers¶

プロジェクトに適用されるtrove classifiers。

[project]
...
classifiers = [
  "...",
]

URLs¶

キーがURLラベルで、値がURL自体であるURLのテーブル。

[project.urls]
Documentation = "..."
"Source code" = "..."

Dependencies¶

詳細については、dependency specificationページを参照してください。

エントリは、デフォルトでcontext formattingとdisallow direct referencesをサポートします。

Required¶

[project]
...
dependencies = [
  "...",
]

Optional¶

[project.optional-dependencies]
option1 = [
  "...",
]
option2 = [
  "...",
]

Entry points¶

Entry pointsは、プロジェクトが提供するコンポーネントを他のコードによって検出および使用されるようにアドバタイズするためのメカニズムです。

CLI¶

CLIスクリプトを定義するプロジェクトをインストールした後、各キーは、関連するオブジェクトを呼び出すコマンドとしてPATHで使用できるようになります。

[project.scripts]
cli-name = "pkg.subpkg:func"

上記の例では、cli-nameを実行すると、基本的に次のPythonスクリプトが実行されます。:

import sys

from pkg.subpkg import func

sys.exit(func())

GUI¶

GUIスクリプトはCLIスクリプトとまったく同じですが、Windowsではコンソールなしで起動できるように特別に処理されます。

[project.gui-scripts]
gui-name = "pkg.subpkg:func"

Plugins¶

[project.entry-points.plugin-namespace]
plugin-name1 = "pkg.subpkg1"
plugin-name2 = "pkg.subpkg2:func"

Dynamic¶

versionのように、メタデータフィールドが動的に設定されている場合は、ここにリストする必要があります。

[project]
...
dynamic = [
  "...",
]

Metadata options¶

Allowing direct references¶

デフォルトでは、dependenciesはdirect referencesを定義することはできません。このチェックを無効にするには、allow-direct-referencesをtrueに設定します。:

[tool.hatch.metadata]
allow-direct-references = true

[metadata]
allow-direct-references = true

Allowing ambiguous features¶

デフォルトでは、optional dependenciesの名前はあいまいさを防ぐために正規化されます。この正規化を無効にするには、allow-ambiguous-featuresをtrueに設定します::

[tool.hatch.metadata]
allow-ambiguous-features = true

[metadata]
allow-ambiguous-features = true