Как включить данные пакета в setuptools / distribue?

При использовании setuptools / распространять, я не могу заставить установщик вытянуть какие-либо 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/расположение файлов данных.

Я понимаю, что это старый вопрос, но для людей, которые находят свой путь через Google: package_dataэто грязная ложь . Он используется только при сборке бинарных пакетов ( python setup.py bdist ...), но не при сборке пакетов с исходным кодом ( python setup.py sdist ...). Это, конечно, смешно - можно было бы ожидать, что создание исходного дистрибутива приведет к коллекции файлов, которые могут быть отправлены кому-то еще для создания бинарного дистрибутива.

В любом случае, использование MANIFEST.inбудет работать как для двоичного, так и для исходного дистрибутива.

У меня была такая же проблема. Решение было просто удалить include_package_data=True.

После прочтения здесь , я понял , что include_package_dataцели включать файлы из контроля версий , а не просто «включает в себя данные пакета» , как следует из названия. Из документов:

Файлы данных [of include_package_data] должны находиться под контролем CVS или Subversion

...

Если вы хотите более детальный контроль над тем, какие файлы включены (например, если у вас есть файлы документации в ваших каталогах пакетов и вы хотите исключить их из установки), вы также можете использовать package_dataключевое слово.

Устранение этого аргумента исправило его, что, по совпадению, также сработало, когда вы переключились на distutils, поскольку он не принимает этот аргумент.

Следование рекомендации @Joe по удалению include_package_data=Trueстроки также сработало для меня.

Чтобы уточнить немного, у меня нет MANIFEST.in файла. Я использую Git, а не CVS.

Репозиторий принимает такую ​​форму:

/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 упомянул, что это действительно полезно как есть)

Обновление : этот ответ старый и информация больше не действительна. Все конфиги 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  

Перемещение папки с данными пакета в папку модуля решило проблему для меня.

Смотрите этот вопрос: MANIFEST.in игнорируется в "python setup.py install" - файлы данных не установлены?

У меня была такая же проблема в течение нескольких дней, но даже эта ветка не смогла мне помочь, потому что все сбивало с толку. Поэтому я провел исследование и нашел следующее решение:

В основном в этом случае вы должны сделать:

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,

из вашего скрипта установки, и он будет работать нормально. (Протестировано только сейчас с последними установочными инструментами.)

Использование setup.cfg (setuptools ≥ 30.3.0)

Начиная с setuptools 30.3.0 (выпущен 2016-12-08), вы можете сохранить setup.pyочень маленький размер и перенести конфигурацию в setup.cfgфайл. При таком подходе вы можете поместить данные вашего пакета в [options.package_data]раздел:

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

В этом случае ваш setup.pyможет быть коротким как:

from setuptools import setup
setup()

Для получения дополнительной информации см. Настройка настройки с использованием файлов setup.cfg .

Есть некоторые разговоры об осужденииsetup.cfg в пользу того, pyproject.tomlчто предложено в PEP 518 , но это все еще временно на 2020-02-21.