Як включити статичні файли до 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)

і txt не додано! Ні, static/data.txtні Potato/potatoData.txt...

Чого мені не вистачає ?!

Відповіді:


127

Як зазначено в коментарях, є 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


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_dataпроти 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

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



Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.