setuptools / distributeにパッケージデータを含める方法は？

setuptools / distributeを使用すると、インストーラーがpackage_dataファイルをプルできません。私が読んだすべては、以下がそれを行う正しい方法であると言います。誰かがアドバイスしてくれませんか？

setup(
   name='myapp',
   packages=find_packages(),
   package_data={
      'myapp': ['data/*.txt'],
   },
   include_package_data=True,
   zip_safe=False,
   install_requires=['distribute'],
)

どこmyapp/data/のデータファイルの場所があります。

これは古い質問であることは承知していますpackage_dataが、Google経由でここに行く道を見つける人々にとって は、卑劣な嘘です。バイナリパッケージを構築する場合にのみ使用され（python setup.py bdist ...）、ソースパッケージを構築する場合には使用されません（python setup.py sdist ...）。もちろん、これはとんでもないことです。ソース配布を構築すると、ファイルのコレクションが他の誰かに送信されてバイナリ配布を構築できると予想されます。

いずれの場合でも、使用MANIFEST.inはバイナリとソース配布の両方で機能します。

私はこれと同じ問題を抱えていました。解決策は、単に削除することinclude_package_data=Trueでした。

ここを読んだ後、名前が示すように単に「パッケージデータを含める」のではなく、バージョン管理include_package_dataからファイルを含めることを目的としていることに気付きました。ドキュメントから：

[include_package_dataの]データファイルはCVSまたはSubversionの制御下にある必要があります

...

含めるファイルをより詳細に制御する場合（たとえば、パッケージディレクトリにドキュメントファイルがあり、それらをインストールから除外する場合）、package_dataキーワードを使用することもできます。

その議論を取り除いてそれを修正しました、それは偶然に、その議論を取りませんので、distutilsに切り替えたときにも機能した理由です。

include_package_data=True行を削除する@Joeの推奨に従うことも私にとってうまくいきました。

もう少し詳しく説明すると、ファイルがありません MANIFEST.in。CVSではなくGitを使用しています。

リポジトリはこのような形をとります：

/myrepo
    - .git/
    - setup.py
    - myproject
        - __init__.py
        - some_mod
            - __init__.py
            - animals.py
            - rocks.py
        - config
            - __init__.py
            - settings.py
            - other_settings.special
            - cool.huh
            - other_settings.xml
        - words
            - __init__.py
            word_set.txt

setup.py：

from setuptools import setup, find_packages
import os.path

setup (
    name='myproject',
    version = "4.19",
    packages = find_packages(),  
    # package_dir={'mypkg': 'src/mypkg'},  # didnt use this.
    package_data = {
        # If any package contains *.txt or *.rst files, include them:
        '': ['*.txt', '*.xml', '*.special', '*.huh'],
    },

#
    # Oddly enough, include_package_data=True prevented package_data from working.
    # include_package_data=True, # Commented out.
    data_files=[
#               ('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
        ('/opt/local/myproject/etc', ['myproject/config/settings.py', 'myproject/config/other_settings.special']),
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'cool.huh')]),
#
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'other_settings.xml')]),
        ('/opt/local/myproject/data', [os.path.join('myproject/words', 'word_set.txt')]),
    ],

    install_requires=[ 'jsonschema',
        'logging', ],

     entry_points = {
        'console_scripts': [
            # Blah...
        ], },
)

python setup.py sdistソースディストリビューション（バイナリを試していません）を実行します。

そして、真新しい仮想環境の中に、私はmyproject-4.19.tar.gz、ファイルを持っていて、

(venv) pip install ~/myproject-4.19.tar.gz
...

そして、私の仮想環境のインストールになっすべて以外のsite-packages、これらの特別なデータファイルがにインストールされます/opt/local/myproject/dataと/opt/local/myproject/etc。

include_package_data=True 私のために働いた。

gitを使用する場合は、必ずに含めsetuptools-gitてくださいinstall_requires。Manifestすべてのパスを含めるか、含めることよりもはるかに退屈ではありませんpackage_data（私の場合は、あらゆる種類の静的な機能を備えたdjangoアプリです）

（k3-rncが実際に役立つので、k3-rncが言ったように、私のコメントを貼り付けました）

更新：この回答は古く、情報は無効になっています。すべてのsetup.py構成でを使用する必要がありますimport setuptools。https://stackoverflow.com/a/49501350/64313でより完全な回答を追加しました

distutilsに切り替えることでこれを解決しました。配布が非推奨または壊れているようです。

from distutils.core import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_data={
      'myapp': ['data/*.txt'],
   },
)

古代の質問ですが、Pythonのパッケージ管理には、まだ多くのことが望まれています。そのため、指定したディレクトリにローカルでpipを使用してインストールするユースケースがあり、package_dataパスとdata_filesパスの両方が機能しないことに驚いていました。リポジトリにさらに別のファイルを追加することに熱心ではなかったので、data_filesとsetup.pyオプション--install-dataを利用することになりました。このようなもの

pip install . --install-option="--install-data=$PWD/package" -t package  

パッケージデータを含むフォルダーをモジュールフォルダーに移動すると、問題が解決しました。

この質問を参照してください：「python setup.py install」でMANIFEST.inが無視されました-データファイルがインストールされていませんか？

私は数日間同じ問題を抱えていましたが、すべてが混乱していたので、このスレッドでさえ私を助けることができませんでした。だから私は私の研究をして、次の解決策を見つけました：

この場合、基本的には次のようにする必要があります。

from setuptools import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_dir={'myapp':'myapp'}, # the one line where all the magic happens
   package_data={
      'myapp': ['data/*.txt'],
   },
)

他の完全なスタックオーバーフローの答えはこちら

行を削除するだけです：

include_package_data=True,

あなたのセットアップスクリプトから、それはうまくいきます。（現在、最新のsetuptoolsでテストされています。）

setup.cfgの使用（setuptools≥30.3.0）

setuptools 30.3.0（2016年12月8日リリース）以降では、setup.pyサイズを非常に小さく保ち、構成をsetup.cfgファイルに移動できます。このアプローチでは、パッケージデータを[options.package_data]セクションに配置できます。

[options.package_data]
* = *.txt, *.rst
hello = *.msg

この場合、次のsetup.pyように短くすることができます。

from setuptools import setup
setup()

詳細については、setup.cfgファイルを使用したセットアップの構成を参照してください。

PEP 518で提案さsetup.cfgれているように非推奨にするという話がいくつかありますが、これは2020-02-21の時点ではまだ暫定的です。pyproject.toml