python - 配布を使用してサンプル スクリプトをパッケージ化する方法は?

Question

配布を使用して、小さな python ライブラリをパッケージ化します。Hitchhiker's Guide to Packagingで説明されているように、ディレクトリ構造を作成しました。

私の質問: (ディレクトリ構造の) どこにライブラリの使用方法を示すサンプル スクリプトを配置し、どのような変更が必要setup.pyですか?

Answer 1

例をインストールするのではなく、examplesフォルダをディストリビューションと一緒に保持できるので、setup.pyと同じレベルにある可能性があります。

それらを含める場合は、「example」のようにパッケージの個別のモジュールとして含めます。そのディレクトリには、インストール後もユーザーが参照できるすべてのサンプルスクリプトが含まれます。

package_data = {
        'module_1': [files],
        'module_2': [files],
        'example': [files],
}

Answer 2

サンプル スクリプトはドキュメントの一種であるため、他のドキュメントをインストールするのと同じ方法でインストールします: package_data として。