Вероятно, лучший способ сделать это - использовать директиву setuptools package_data. Это означает использование setuptools (или _ 4_) вместо 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-packages, вам необходимо указать include_package_data=True функции setup(). Дополнительную информацию см. В разделе Добавление файлов без кода.

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

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

Шаг 1. Чтобы добавить файл в исходный архив, включите его в МАНИФЕСТ

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

МАНИФЕСТ - это, по сути, текстовый файл со списком всех файлов, которые будут включены в исходный архив.

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

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

Примечание. Хотя sdist действительно добавляет некоторые файлы автоматически , я предпочитаю явно указывать их, чтобы быть уверенным, вместо того, чтобы предсказывать, что он делает, а что нет.

from distutils.command.install import INSTALL_SCHEMES

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

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

Сейчас 2019 год, и вот что работает - несмотря на советы здесь и там, то, что я нашел в Интернете, наполовину задокументировано, это использование setuptools_scm, переданное в качестве параметров setuptools.setup. Это будет включать в пакет wheel любые файлы данных с версией на вашей VCS, будь то git или любой другой, и будет производить установку pip из репозитория 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, который я ввел, но оставлять важные файлы для работы программы - это несколько важный)

создайте MANIFEST.in в корне проекта с помощью recursive-include в требуемый каталог или include с именем файла.

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

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

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

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

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

Шаг 3: установите include_package_data=True в функции setup(), чтобы скопировать эти файлы в site-package.

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

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

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

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

include_package_data: False

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

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

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

В setup.py в разделе настройки (:

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

Это работает в 2020 году!

Как говорили другие, создайте MANIFEST.in, где находится ваш setup.py.

Далее в манифесте включаем / исключаем все необходимое. Будьте осторожны с синтаксисом. Пример: допустим, у нас есть папка с шаблоном, которую нужно включить в исходный пакет.

в файле манифеста сделайте следующее:

recursive-include template *

Убедитесь, что вы оставили пробел между именем каталога и шаблоном для файлов / каталогов, как указано выше. Не делайте этого, как мы делаем в .gitignore

recursive-include template/* [this won't work]

Другой вариант - использовать include. Вариантов масса. Посмотрите здесь их документы для Manifest.in

И последний важный шаг: включите этот параметр в свой setup.py, и все готово!

   setup(
    ...
    include_package_data=True,
    ......
)

Надеюсь, это поможет! Удачного кодирования!

Вот более простой ответ, который сработал для меня.

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

В конце концов, я смог добавить файлы в свое решение, используя «параметры» в setup / setuptools. Файлы параметров позволяют изменять различные разделы файла спецификации из setup.py. Следующее.

from setuptools import setup


setup(
    name='theProjectName',
    version='1',
    packages=['thePackage'],
    url='',
    license='',
    author='me',
    author_email='[email protected]',
    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

Ничего из вышеперечисленного не помогло мне. Что меня спасло, так это этот ответ.
Очевидно, чтобы эти файлы данных были извлечены во время установки, я пришлось сделать пару вещей:

1. Как уже упоминалось - добавьте MANIFEST.in в проект и укажите папку / файлы, которые вы хотите включить. В моем случае: recursive-include folder_with_extra_stuff *
2. Опять же, как уже было сказано - добавьте include_package_data=True в свой setup.py. Это очень важно, потому что без него будут перенесены только файлы, соответствующие *.py.
3. Вот чего не хватало! - Добавьте пустой __init__.py в папку с данными. Мне пришлось добавить этот файл в свой folder-with-extra-stuff.
4. Дополнительно - Не уверен, что это требование, но с моими собственными модулями Python я увидел, что они заархивированы внутри файла .egg в site-packages. Поэтому мне пришлось добавить zip_safe=False в мой setup.py файл.

Окончательная структура каталогов

my-app/
├─ app/
│  ├─ __init__.py
│  ├─ __main__.py
├─ folder-with-extra-stuff/
│  ├─ __init__.py
│  ├─ data_file.json
├─ setup.py
├─ MANIFEST.in

Ни один из ответов не помог мне, потому что мои файлы были на верхнем уровне, вне пакета. Вместо этого я использовал пользовательскую команду сборки.

import os
import setuptools
from setuptools.command.build_py import build_py
from shutil import copyfile

HERE = os.path.abspath(os.path.dirname(__file__))
NAME = "thepackage"

class BuildCommand(build_py):
    def run(self):
        build_py.run(self)

        if not self.dry_run:
            target_dir = os.path.join(self.build_lib, NAME)
            for fn in ["VERSION", "LICENSE.txt"]:
                copyfile(os.path.join(HERE, fn), os.path.join(target_dir,fn))

 
 
setuptools.setup(
    name=NAME,
    cmdclass={"build_py": BuildCommand},
    description=DESCRIPTION,
    ...
)

Я придумал обходной путь: я переименовал свой lgpl2.1_license.txt в lgpl2.1_license.txt.py и заключил текст в тройные кавычки. Теперь мне не нужно использовать параметр data_files или указывать какие-либо абсолютные пути. Я знаю, что делать его модулем Python некрасиво, но я считаю это менее уродливым, чем указание абсолютных путей.