Как включить статические файлы в setuptools - пакет python

Я хочу включить ./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 = "[email protected]",
    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)

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

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

Ответы

Ответ 1

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

Ответ 2

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

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

где project_name - это папка в той же строке, где у вас есть файл setup.py.

Ответ 3

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

Ответ 4

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

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

package_data={'templates':['*'],'static':['*'],'docs':['*'],},