Как сделать, чтобы 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']}

Решение здесь определенно не в том, чтобы переименовывать ваши не pyфайлы с .pyрасширением.

Смотрите презентацию Яна Бикинга для получения дополнительной информации.

ОБНОВЛЕНИЕ: другой [лучший] подход

Другой подход, который работает хорошо, если вы просто хотите контролировать содержимое исходного дистрибутива ( sdist) и иметь файлы вне пакета (например, каталог верхнего уровня), - это добавить MANIFEST.inфайл. См. Документацию Python для формата этого файла.

С тех пор, как я написал этот ответ, я обнаружил, что использование, MANIFEST.inкак правило, менее разочаровывающий подход - просто убедиться, что ваш исходный дистрибутив ( tar.gz) имеет нужные вам файлы.

Например, если вы хотите включить requirements.txtиз верхнего уровня, рекурсивно включите каталог «данных» верхнего уровня:

include requirements.txt
recursive-include data *

Тем не менее, для того, чтобы эти файлы были скопированы во время установки в папку пакета внутри site-пакетов, вам необходимо предоставить include_package_data=Trueэту setup()функцию. См. Добавление файлов без кода для получения дополнительной информации.

Чтобы выполнить то, что вы описываете, потребуется два шага ...

• Файл должен быть добавлен в исходный архив
• setup.py необходимо изменить, чтобы установить файл данных в исходный путь

Шаг 1: Чтобы добавить файл в исходный архив, включите его в MANIFEST

Создайте шаблон MANIFEST в папке, содержащей setup.py

MANIFEST - это текстовый файл со списком всех файлов, которые будут включены в исходный архив.

Вот как выглядит МАНИФЕСТ для моего проекта:

• 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-includeнужным каталогом или includeс именем файла.

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

документацию можно найти здесь

Я хотел оставить комментарий к одному из вопросов, но у меня недостаточно репутации, чтобы сделать это>.>

Вот что сработало для меня (придумал это после обращения к документации):

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

include_package_data: False

Последняя строка была, как ни странно, также крайне важной для меня (вы также можете опустить этот аргумент ключевого слова - он работает так же).

Он копирует все текстовые файлы в вашем верхнем или корневом каталоге (на один уровень выше от пакета, который mypkgвы хотите распространять).

Надеюсь это поможет!

Это 2019 год, и вот что работает - несмотря на то, что советы здесь и там, то, что я нашел в интернете на полпути, документировано, используется setuptools_scm, и передается как опция setuptools.setup. Это будет включать любые файлы данных, которые являются версиями на вашей VCS, будь то git или любые другие, в пакет wheel, и будет выполнять «pip install» из репозитория git, чтобы привести эти файлы вместе.

Итак, я просто добавил эти две строки в вызов установки «setup.py». Никаких дополнительных установок или импорта не требуется:

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

Нет необходимости вручную указывать package_data или в файле MANIFEST.in - если он версионный, он включается в пакет. В документах «setuptools_scm» делается акцент на создании номера версии из позиции фиксации и не учитывается действительно важная часть добавления файлов данных. (Меня не волнует, если мой файл промежуточного колеса называется «* 0.2.2.dev45 + g3495a1f» или будет использовать номер версии в жестком коде «0.3.0dev0», который я набрал - но оставляю важные файлы для программы, чтобы работа позади несколько важна)

Шаг 1: создайте MANIFEST.inфайл в той же папке с setup.py

Шаг 2: включите относительный путь к файлам, которые вы хотите добавить вMANIFEST.in

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

Шаг 3: установите include_package_data=Trueв setup()функции копирование этих файлов в сайт-пакет

Ссылка здесь.

В setup.py под настройку (:

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']},
)

Я просто хотел продолжить что-то, что я нашел, работая с Python 2.7 на Centos 6. Добавление 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

файл - файл с командами установки:

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 некрасиво, но считаю его менее уродливым, чем указание абсолютных путей.