Как добавить дополнительные файлы на колесо?

Ответ 1

Вы пытались использовать package_data в своем setup.py? MANIFEST.in кажется целевым для версий python <= 2.6, я не уверен, что более высокие версии даже смотрят на него.

После изучения https://github.com/pypa/sampleproject их MANIFEST.in говорит:

# If using Python 2.6 or less, then have to include package data, even though
# it already declared in setup.py
include sample/*.dat

который, по-видимому, подразумевает, что этот метод устарел. Между тем, в setup.py они объявляют:

setup(
    name='sample',
    ...
    # If there are data files included in your packages that need to be
    # installed, specify them here.  If using Python 2.6 or less, then these
    # have to be included in MANIFEST.in as well.
    package_data={
        'sample': ['package_data.dat'],
    },
    ...
)

(Я не уверен, почему они выбрали шаблон в MANIFEST.in и имя файла в setup.py. Они ссылаются на тот же файл)

Который, наряду с более простым, снова, кажется, подразумевает, что маршрут package_data превосходит метод MANIFEST.in. Ну, если вам не нужно поддерживать 2,6, то есть в этом случае мои молитвы выходят к вам.

Ответ 2

Вы можете указать дополнительные файлы для установки с помощью директивы data_files. Это то, что вы ищете? Вот небольшой пример:

from setuptools import setup
from glob import glob

setup(
    name='extra',
    version='0.0.1',
    py_modules=['extra'],
    data_files=[
        ('images', glob('assets/*.png')),
    ],
)

Ответ 3

Прежде чем вносить какие-либо изменения в MANIFEST.in или setup.py, необходимо удалить старые выходные каталоги. Setuptools кэширует некоторые данные, и это может привести к неожиданным результатам.

rm -rf build *.egg-info

Если вы этого не сделаете, не ожидайте, что ничего не будет работать правильно.

Теперь это не так.

1. Если вы создаете исходный дистрибутив (sdist), вы можете использовать любой метод ниже.

2. Если вы строите колесо (bdist_wheel), затем include_package_data и MANIFEST.in игнорируются, и вы должны использовать package_data и data_files.

INCLUDE_PACKAGE_DATA

Это хороший вариант, но bdist_wheel не соблюдает его.

setup(
    ...
    include_package_data=True
)

# MANIFEST.in
include package/data.json

DATA_FILES для непакетных данных

Это наиболее гибкий вариант, потому что вы можете добавить любой файл из вашего репо в sdist или bdist_wheel

setup(
    ....
    data_files=[
        ('output_dir':['conf/data.json']),
    ]
    # For sdist, output_dir is ignored!
    #
    # For bdist_wheel, data.json from conf dir in root of your repo 
    # and stored at 'output_dir/' inside of the sdist package.
)

PACKAGE_DATA для не-python файлов внутри пакета

Как и выше, но для bdist_wheel вы можете поместить свои файлы данных в пакет. Он идентичен для sdist но имеет больше ограничений, чем data_files потому что файлы могут data_files только из вашего data_files пакета.

setup(
    ...
    package_data={'package':'data.json'},
    # data.json must be inside of your actual package
)

Ответ 4

Вы можете использовать package_data и data_files в setup.py указать дополнительные файлы, но они до смешного трудно получить права (и глючит).

Альтернативой является использование MANIFEST.in и добавление include_package_data=True в setup() вашего setup.py как указано здесь.

С помощью этой директивы MANIFEST.in будет использоваться для указания файлов, которые будут включены не только в исходный архив tar/zip, но также в установщик wheel и win32. Это также работает с любой версией Python (я тестировал проект от py2.6 до py3.6).

Ответ 5

У меня был каталог config/с файлами JSON, которые мне нужно было добавить в пакет wheel. Итак, я добавил эти строки в MANIFEST.in:

recursive-include config/ *.json

Следующая директива для setup.py:

setup(
 ...
 include_package_data=True,
)

И ничего не сработало. Пока я не создал пустой файл с именем __init__.py внутри директории config/.

(Python 3.6.7, колесо 3.6.7, setuptools 39.0.1)

Ответ 6

"Колесо представляет собой архив в формате ZIP..." (http://wheel.readthedocs.org/en/latest)

Итак, обрабатывайте файл .whl так же, как и .zip файл. Добавьте файл с помощью

• Python ZipFile object
• любая утилита архива /zip файла, такая как 7-zip, Winzip, Ark, файловый ролик и т.д.