setuptoolsに静的ファイルを含める方法-pythonパッケージ


83

私に含める./static/data.txtにはsetuptools、ここに私のコードは次のとおりです。

# setup.py
import os,glob
from setuptools import setup,find_packages

setup(
    name = "PotatoProject",
    version = "0.1.1",
    author = "Master Splinter",
    author_email = "splinter@initech.com",
    description = ("The potatoproject!"),
    url = 'http://www.google.com',
    license = "BSD",

    # adding packages
    packages=find_packages('src'),
    package_dir = {'':'src'},

    # trying to add files...
    include_package_data = True,
    package_data = {
        '': ['*.txt'],
        '': ['static/*.txt'],
        'static': ['*.txt'],
    },

    scripts=['src/startPotato'],
    classifiers=[
        "Development Status :: 3 - Alpha",
        "Topic :: Utilities",
        "License :: OSI Approved :: BSD License",
    ],
)

ファイルシステム:

.
├── setup.py
└── src
    ├── distutils_setup.py
    ├── Potato
    │   ├── __init__.py
    │   ├── potatoData.txt
    │   └── printer.py
    ├── startPotato
    ├── static
    │   └── data.txt
    └── Tomato
        ├── big.py
        └── __init__.py

実行時の出力: python setup.py sdist

running sdist
running egg_info
creating src/PotatoProject.egg-info
writing src/PotatoProject.egg-info/PKG-INFO
writing top-level names to src/PotatoProject.egg-info/top_level.txt
writing dependency_links to src/PotatoProject.egg-info/dependency_links.txt
writing manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
reading manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
writing manifest file 'src/PotatoProject.egg-info/SOURCES.txt'
warning: sdist: standard file not found: should have one of README, README.txt

creating PotatoProject-0.1.1
creating PotatoProject-0.1.1/src
creating PotatoProject-0.1.1/src/Potato
creating PotatoProject-0.1.1/src/PotatoProject.egg-info
creating PotatoProject-0.1.1/src/Tomato
making hard links in PotatoProject-0.1.1...
hard linking setup.py -> PotatoProject-0.1.1
hard linking src/startPotato -> PotatoProject-0.1.1/src
hard linking src/Potato/__init__.py -> PotatoProject-0.1.1/src/Potato
hard linking src/Potato/printer.py -> PotatoProject-0.1.1/src/Potato
hard linking src/PotatoProject.egg-info/PKG-INFO -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/SOURCES.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/dependency_links.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/PotatoProject.egg-info/top_level.txt -> PotatoProject-0.1.1/src/PotatoProject.egg-info
hard linking src/Tomato/__init__.py -> PotatoProject-0.1.1/src/Tomato
hard linking src/Tomato/big.py -> PotatoProject-0.1.1/src/Tomato
Writing PotatoProject-0.1.1/setup.cfg
creating dist
Creating tar archive
removing 'PotatoProject-0.1.1' (and everything under it)

txtは追加されていません!いいえstatic/data.txtPotato/potatoData.txt...

何が足りないの?

回答:


122

コメントで指摘されているように、静的ファイルを追加するには2つの方法があります。

1-include_package_data = True + MANIFEST.in

MANIFEST.in同じディレクトリ内のファイルsetup.pyのようなものになります。

include src/static/*
include src/Potato/*.txt

include_package_data = Trueの中でsetup.py

2-setup.pyのpackage_data

package_data = {
    'static': ['*'],
    'Potato': ['*.txt']
}

内のファイルを指定しますsetup.py


両方使用しないでくださいinclude_package_datapackage_dataではsetup.py

include_package_datapackage_data情報を無効にします。

https://setuptools.readthedocs.io/en/latest/setuptools.html#include-data-files


3
動作します!どうやら、MANIFEST.inは、デフォルトで含めるのに十分賢いsetup.py / distutilsに加えて、含めるファイルを選択します。
chbrown 2014年

13
これを実行し、include_package_data = True上記を追加することで、私はうまくいきました。マニフェストファイルとsetup.pyディレクティブの両方を実行する必要がありました。
djhaskin987 2015年

「include * .txt」を追加するだけです。素晴らしいthnxで動作します
Priyeshj

7
を指定するときはいつでもinclude_package_data=True、基本的にの効果を無効にすることに注意しpackage_dataてくださいMANIFEST.in。そのため、setuptoolsはファイルをに含めることを期待しています。両方ではなく、一方(package_datavs include_package_data=True+ MANIFEST.in)を使用してください。
konoufo 2018

実行時に静的ディレクトリに書き込むことは可能ですか?
毛深い

28

すべてのファイルを再帰的に含めます。

recursive-include project_name/templates *
recursive-include project_name/static *

ここproject_nameで、はsetup.pyファイルがあるのと同じ行のフォルダです。


1
:あなたはまた、単一のファイルで含めることができますinclude funniest/data.json例えば
ロドリゴ・ディアス

11

ドキュメントによると、パッケージデータファイルを含めるには3つの方法があります。ポテトとトマトの2つのパッケージがあります。静的ディレクトリはこれらのパッケージのいずれにも含まれていないため、setup.pyのpackage_dataディクショナリが機能していませんでした。マニフェストオプションでは、setup.pyでinclude_package_dataがTrueに設定されている必要があります。パッケージ以外のデータファイルへのアクセスは、ここにある方法で行うことができます


6

以下を使用してください

packages = ['.','templates','static','docs'],

package_data={'templates':['*'],'static':['*'],'docs':['*'],},

1
これは包括的すぎる可能性があります。
acumenus 2017年

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.