setup.pyコードの一部ではないファイルを含めるにはどうすればよいですか？（具体的には、ライセンスファイルですが、それ以外の場合もあります。）

ファイルの場所を制御できるようにしたい。元のソースフォルダーでは、ファイルはパッケージのルートにあります。（つまり、最上位と同じレベルにあり__init__.pyます。）パッケージは、オペレーティングシステムに関係なく、インストールされたときに、その場所に正確に残しておく必要があります。それ、どうやったら出来るの？

おそらくこれを行うための最良の方法は、setuptools package_dataディレクティブを使用することです。これはの代わりにsetuptools（またはdistribute）を使用することを意味しますがdistutils、これは非常にシームレスな「アップグレード」です。

以下は完全な（ただしテストされていない）例です。

from setuptools import setup, find_packages

setup(
    name='your_project_name',
    version='0.1',
    description='A description.',
    packages=find_packages(exclude=['ez_setup', 'tests', 'tests.*']),
    package_data={'': ['license.txt']},
    include_package_data=True,
    install_requires=[],
)

ここで重要な特定の行に注意してください：

package_data={'': ['license.txt']},
include_package_data=True,

package_dataあるdictパターンのリストにパッケージ名（空=すべてのパッケージ）（グロブを含めることができる）の。たとえば、パッケージ内のファイルのみを指定する場合は、次のようにすることもできます。

package_data={'yourpackage': ['*.txt', 'path/to/resources/*.txt']}

ここでの解決策は間違いありません、あなた以外名前を変更するためにpyAを使用してファイルを.py拡張子の。

詳細については、Ian Bickingのプレゼンテーションを参照してください。

更新：別の[より良い]アプローチ

ソース配布（sdist）のコンテンツを制御し、パッケージの外部にファイル（たとえば、最上位ディレクトリ）を置きたいだけの場合にうまく機能する別のアプローチは、MANIFEST.inファイルを追加することです。このファイルの形式については、Pythonのドキュメントを参照してください。

この応答を書いて以来MANIFEST.in、ソース配布（tar.gz）に必要なファイルが含まれていることを確認するだけで、通常はを使用した方がイライラすることは少ないことがわかりました。

たとえばrequirements.txt、最上位のfrom を含める場合は、最上位の「データ」ディレクトリを再帰的に含めます。

include requirements.txt
recursive-include data *

それにもかかわらず、これらのファイルをインストール時にsite-packages内のパッケージのフォルダーにコピーするinclude_package_data=Trueには、setup()関数に供給する必要があります。詳細については、非コードファイルの追加を参照してください。

あなたが説明していることを達成するには、2つのステップを踏みます...

• ファイルをソースtarballに追加する必要があります
• データファイルをソースパスにインストールするには、setup.pyを変更する必要があります

手順1：ファイルをソースtarballに追加するには、マニフェストに含めます

setup.pyを含むフォルダーにMANIFESTテンプレートを作成します

MANIFESTは基本的に、ソースtarballに含まれるすべてのファイルのリストを含むテキストファイルです。

私のプロジェクトのマニフェストは次のようになります。

• CHANGELOG.txt
• INSTALL.txt
• LICENSE.txt
• pypreprocessor.py
• README.txt
• setup.py
• test.py
• TODO.txt

注：sdist は一部のファイルを自動的に追加しますが、何を行うか、または行わないかを予測するのではなく、ファイルを確実に明示的に指定することをお勧めします。

手順2：データファイルをソースフォルダーにインストールするには、setup.pyを変更します。

データファイル（LICENSE.txt）をソースインストールフォルダーに追加しようとしているので、データインストールパスをソースインストールパスと一致するように変更する必要があります。デフォルトでは、データファイルはソースファイルとは異なる場所にインストールされるため、これが必要です。

ソースインストールディレクトリと一致するようにデータインストールディレクトリを変更するには...

次のコマンドを使用して、distutilsからインストールディレクトリ情報を取得します。

from distutils.command.install import INSTALL_SCHEMES

ソースインストールディレクトリと一致するようにデータインストールディレクトリを変更します。

for scheme in INSTALL_SCHEMES.values():
    scheme['data'] = scheme['purelib']

そして、データファイルと場所をsetup（）に追加します。

data_files=[('', ['LICENSE.txt'])]

注：上記の手順は、拡張ライブラリを必要とせずに、標準的な方法で説明したとおりに実行する必要があります。

必要なディレクトリまたはファイル名を使用MANIFEST.inして、プロジェクトルートに作成します。recursive-includeinclude

include LICENSE
include README.rst
recursive-include package/static *
recursive-include package/templates *

ドキュメントはここにあります

質問の1つにコメントを投稿したかったのですが、その評判が十分ではありません>。>

これは私のために働いたものです（ドキュメントを参照した後それを思いついた）：

package_data={
    'mypkg': ['../*.txt']
},

include_package_data: False

最後の行は、奇妙なことに、私にとっても非常に重要でした（このキーワード引数を省略してもかまいません。同じように機能します）。

これは、トップレベルまたはルートディレクトリ（パッケージから1レベル上の）にあるすべてのテキストファイルをコピーします mypkg配布ことです。

お役に立てれば！

ステップ1：を作成するMANIFEST.in setup.pyと同じフォルダーにファイルを

手順2：追加するファイルへの相対パスを含めるMANIFEST.in

include README.rst
include docs/*.txt
include funniest/data.json

手順3：これらのファイルをサイトパッケージにコピーinclude_package_data=Trueするsetup()関数を設定する

参考はこちら。

それは2019年であり、ここが機能しています-あちこちでアドバイスにもかかわらず、ドキュメントの途中でインターネット上で見つけたものはを使用してsetuptools_scmに渡され、にオプションとして渡されますsetuptools.setup。これには、VCSでバージョン管理されているデータファイル（gitまたはその他）がwheelパッケージに含まれ、gitリポジトリから "pip install"を実行して、それらのファイルをまとめます。

したがって、「setup.py」のセットアップ呼び出しにこれらの2行を追加しました。追加のインストールやインポートは必要ありません。

    setup_requires=['setuptools_scm'],
    include_package_data=True,

package_dataまたはMANIFEST.inファイルに手動でリストする必要はありません。バージョン管理されている場合、パッケージに含まれています。「setuptools_scm」に関するドキュメントでは、コミット位置からのバージョン番号の作成に重点が置かれ、データファイルの追加の非常に重要な部分は無視されます。（中間ホイールファイルの名前が「* 0.2.2.dev45 + g3495a1f」であるか、入力したハードコードされたバージョン番号「0.3.0dev0」を使用するかどうかは問題ありませんが、プログラムに重要なファイルを残して、背後での作業はやや重要です）

setup.pyのsetup（：

setup(
   name = 'foo library'
   ...
  package_data={
   'foolibrary.folderA': ['*'],     # All files from folder A
   'foolibrary.folderB': ['*.txt']  #All text files from folder B
   },

ここに私のために働いたより簡単な答えがあります。

まず、上記のPython Devのコメントによると、setuptoolsは必要ありません。

package_data is also available to pure distutils setup scripts 
since 2.3. – Éric Araujo

パッケージにsetuptools要件を課すと、それもインストールする必要があるため、これは素晴らしいことです。要するに：

from distutils.core import setup

setup(
    # ...snip...
    packages          = ['pkgname'],
    package_data      = {'pkgname': ['license.txt']},
)

Centos 6でPython 2.7を使用して動作しているのを確認したいだけです。上記のようにpackage_dataまたはdata_filesを追加してもうまくいきませんでした。必要なファイルを含むMANIFEST.INを追加して、非Pythonファイルをtarballに入れましたが、RPM経由でターゲットマシンにインストールしませんでした。

最終的に、setup / setuptoolsの「オプション」を使用して、ソリューションにファイルを取り込むことができました。オプションファイルを使用すると、仕様ファイルのさまざまなセクションをsetup.pyから変更できます。次のように。

from setuptools import setup


setup(
    name='theProjectName',
    version='1',
    packages=['thePackage'],
    url='',
    license='',
    author='me',
    author_email='me@email.com',
    description='',
    options={'bdist_rpm': {'install_script': 'filewithinstallcommands'}},
)

ファイル-MANIFEST.in：

include license.txt

file-filewithinstallcommands：

mkdir -p $RPM_BUILD_ROOT/pathtoinstall/
#this line installs your python files
python setup.py install -O1 --root=$RPM_BUILD_ROOT --record=INSTALLED_FILES
#install license.txt into /pathtoinstall folder
install -m 700 license.txt $RPM_BUILD_ROOT/pathtoinstall/
echo /pathtoinstall/license.txt >> INSTALLED_FILES

回避策を考え出した：私は私の名前を変更lgpl2.1_license.txtしlgpl2.1_license.txt.py、テキストの周りにいくつかのトリプル引用符を置きます。これで、data_filesオプションを使用したり、絶対パスを指定したりする必要はありません。それをPythonモジュールにすることは醜いことですが、絶対パスを指定するよりも醜いとは思いません。