Как включить статические файлы в 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)

и текст не добавлен! Нет static/data.txtи Potato/potatoData.txt...

Что мне не хватает ?!

python package setuptools Joaoricardo000
источник

Ответы:

126

Как указано в комментариях, есть 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 - package_data в setup.py

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

Укажите файлы внутри setup.py.

Не используйте оба include_package_dataи package_dataв setup.py.

include_package_dataаннулирует package_dataинформацию.

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

Joaoricardo000
источник
3
Работает! По-видимому, MANIFEST.in выбирает, какие файлы нужно включить в дополнение к тому, что setup.py / distutils достаточно умен, чтобы включить по умолчанию.
chbrown
13
Выполнение этого плюс добавление include_package_data = Trueвышеупомянутого сработало для меня. Оба должны были быть выполнены: файл манифеста и директива setup.py.
djhaskin987
Я просто добавляю "include * .txt". Работает отлично,
спасибо
7
Следует отметить, что каждый раз, когда вы указываете include_package_data=True, вы в основном сводите на нет эффект package_data, и поэтому setuptools ожидают, что вы включите файлы в ваш MANIFEST.in. Используйте один из них ( package_datavs include_package_data=True+ MANIFEST.in), а не оба.
konoufo
Можно ли писать в статический каталог во время выполнения?
Волосатый
28

Включить все файлы рекурсивно:

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

где project_nameнаходится папка в той же строке, где находится setup.pyфайл.

Антон Данильченко
источник
1
Вы также можете включить один файл с: include funniest/data.jsonнапример
Родриго Диас
11

Согласно документации, есть три способа включить файлы данных пакета. У вас есть два пакета: Potato и Tomato. Статического каталога нет ни в одном из этих пакетов, поэтому ваш словарь package_data в setup.py не работал. Опция manifest требует, чтобы для include_package_data было установлено значение True в setup.py. Доступ к файлам данных, не относящимся к пакетам, можно осуществить способом, указанным здесь .

выбросить
источник
7

Используйте следующие

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

package_data={'templates':['*'],'static':['*'],'docs':['*'],},
Дадасо Занзане
источник
1
Это могло быть слишком инклюзивным.
Acumenus