mgedmin/check-manifest

これは何？

主な機能

• 01バージョン管理下のファイルとビルド済みsdistを比較し、不足しているファイルを一覧表示します。
• 02推奨するincludeルールをMANIFEST.inに自動で追記できます。
• 03MANIFEST.inが存在しない場合に作成します。
• 04pyproject.toml、setup.cfg、tox.iniでファイルやパターンを除外できます。
• 05pre-commit hookとして動作します。

ユースケース

• PyPIにアップロードするPythonパッケージに、テストやデータファイルがすべて含まれているか確認する。
• pre-commitを使い、各gitコミットの前にパッケージングを自動でチェックする。
• プロジェクトの構成変更後、不完全なMANIFEST.inを修正する。

クイックスタート

1. 1

   PyPIからcheck-manifestをインストールします

   pip install check-manifest
2. 2

   Pythonパッケージのソースディレクトリに移動します

   cd ~/src/mygreatpackage
3. 3

   check-manifestを実行して、バージョン管理下のファイルとsdistを比較します

   check-manifest

トピック

よくある質問

check-manifest とは？

Pythonパッケージのsdistにバージョン管理下のファイルがすべて含まれているか確認し、不足があればMANIFEST.inを更新できるコマンドラインツール。 check-manifestは、Pythonパッケージの作者向けのコマンドラインツールです。バージョン管理システム（gitやMercurialなど）で追跡されているファイルと、ビルドしたソースディストリビューション（sdist）の内容を比較し、パッケージに含まれていないファイルを報告します。テスト、設定ファイル、データファイルなどが、Python Package Indexにアップロードするリリースから漏れるという、よくあるパッケージングミスを見つけられます。

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

check-manifest は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

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

活発にメンテナンス中。check-manifest の最終コミットは 2026年10月18日 です。

check-manifest は何に使えますか？

PyPIにアップロードするPythonパッケージに、テストやデータファイルがすべて含まれているか確認する。 pre-commitを使い、各gitコミットの前にパッケージングを自動でチェックする。 プロジェクトの構成変更後、不完全なMANIFEST.inを修正する。

check-manifest のインストール方法は？

PyPIからcheck-manifestをインストールします: pip install check-manifest Pythonパッケージのソースディレクトリに移動します: cd ~/src/mygreatpackage check-manifestを実行して、バージョン管理下のファイルとsdistを比較します: check-manifest

check-manifest はどこで入手できますか？

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