pypa/setuptools-scm

これは何？

主な機能

• 01ビルド時にGitまたはMercurialのタグからバージョンを判定します。
• 02Pythonパッケージのビルドでsetuptoolsと連携します。
• 03setuptoolsなしでも利用できる単独ライブラリvcs-versioningを収録しています。
• 04pytestで実行するテストスイートと、mkdocsでビルドするドキュメントが含まれています。

ユースケース

• バージョン文字列を手作業で編集せずに、PythonパッケージのバージョンをGitタグに連動させる。
• GitまたはMercurialで管理されているPythonプロジェクトのバージョンを管理する。
• setuptoolsを使わないツールで、VCSに基づくバージョン判定を再利用する。

クイックスタート

1. 1

   uvですべてのパッケージと依存関係グループをインストールする

   uv sync --all-packages --all-groups
2. 2

   テストスイートを実行する

   uv run pytest -n12

トピック

よくある質問

setuptools-scm とは？

GitまたはMercurialのタグからパッケージのバージョンを判定し、setuptoolsと連携するPythonツール。 setuptools-scmは、プロジェクトのバージョン管理システムのメタデータ（通常はGitまたはMercurialのタグ）からPythonパッケージのバージョンを取得します。setupファイルでバージョン文字列を手作業で管理する代わりに、ビルド時に最新のタグとコミットの状態からバージョンを算出するため、リリース版と開発版のバージョンをリポジトリの履歴と一致させられます。

setuptools-scm は無料で使えますか？ライセンスは？

setuptools-scm にはライセンスが明記されていません。コードは公開されていますが、ライセンスがない場合は再利用の許諾がないため、利用前に作者に確認することをおすすめします。

setuptools-scm は今もメンテナンスされていますか？

活発にメンテナンス中。setuptools-scm の最終コミットは 2026年11月6日 です。

setuptools-scm は何に使えますか？

バージョン文字列を手作業で編集せずに、PythonパッケージのバージョンをGitタグに連動させる。 GitまたはMercurialで管理されているPythonプロジェクトのバージョンを管理する。 setuptoolsを使わないツールで、VCSに基づくバージョン判定を再利用する。

setuptools-scm のインストール方法は？

uvですべてのパッケージと依存関係グループをインストールする: uv sync --all-packages --all-groups テストスイートを実行する: uv run pytest -n12

setuptools-scm はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/pypa/setuptools-scm