Jak dołączyć pliki statyczne do setuptools - pakiet Pythona

83

Chcę dołączyć ./static/data.txtto setuptools, oto mój kod:

# 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",
    ],
)

System plików:

.
├── setup.py
└── src
    ├── distutils_setup.py
    ├── Potato
    │   ├── __init__.py
    │   ├── potatoData.txt
    │   └── printer.py
    ├── startPotato
    ├── static
    │   └── data.txt
    └── Tomato
        ├── big.py
        └── __init__.py

wyjście podczas pracy: 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)

i nie dodano txt! Nie, static/data.txtani Potato/potatoData.txt...

Czego mi brakuje?!

python package setuptools joaoricardo000
źródło

Odpowiedzi:

126

Jak wskazano w komentarzach, istnieją 2 sposoby dodawania plików statycznych:

1 - include_package_data = True + MANIFEST.in

MANIFEST.inPlik w tym samym katalogu setup.py, który wygląda tak:

include src/static/*
include src/Potato/*.txt

Z include_package_data = Truew setup.py.

2 - dane_pakietu w setup.py

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

Określ pliki wewnątrz setup.py.

Nie używaj jednocześnie include_package_datai package_dataw setup.py.

include_package_dataunieważni package_datainformacje.

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

joaoricardo000
źródło
3
Pracuje! Najwyraźniej MANIFEST.in wybiera, które pliki dołączyć oprócz tego, które setup.py / distutils są wystarczająco inteligentne, aby włączyć je domyślnie.
chbrown
13
Zrobienie tego plus dodanie include_package_data = Truepowyższego zadziałało dla mnie. Trzeba było zrobić jedno i drugie: plik manifestu i dyrektywę setup.py.
djhaskin987
Po prostu dodaję „dołącz * .txt”. Działa świetnie
Priyeshj
7
Należy zauważyć, że za każdym razem, gdy określisz include_package_data=True, w zasadzie anulujesz efekt package_datai dlatego setuptools oczekuje, że włączysz pliki do pliku MANIFEST.in. Użyj jednego z nich ( package_datavs include_package_data=True+ MANIFEST.in), a nie obu.
konoufo
Czy możliwe jest zapisywanie w katalogu statycznym podczas działania?
Hairy
28

Uwzględnij wszystkie pliki rekurencyjnie:

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

gdzie project_namejest folder w tej samej linii, w której masz setup.pyplik.

Anton Danilchenko
źródło
1
Możesz także chcieć dołączyć pojedynczy plik z: include funniest/data.jsonna przykład
Rodrigo Dias
11

Zgodnie z dokumentacją istnieją trzy sposoby dołączania plików danych pakietu. Masz dwa opakowania: Ziemniak i Pomidor. Katalog statyczny nie znajduje się w żadnym z tych pakietów, dlatego słownik package_data w setup.py nie działał. Opcja manifestu wymaga ustawienia parametru include_package_data na True w pliku setup.py. Dostęp do plików danych niebędących pakietami można uzyskać w sposób opisany tutaj .

emispowder
źródło
7

Użyj następujących

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

package_data={'templates':['*'],'static':['*'],'docs':['*'],},
Dadaso Zanzane
źródło
1
To może być zbyt wszechstronne.
Acumenus