Wie statische Dateien in setuptools - python package einbinden

83

Ich möchte das ./static/data.txtto setuptoolseinfügen, hier ist mein Code:

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

Das Dateisystem:

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

die Ausgabe beim Ausführen: 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)

und kein txt hinzugefügt! Nein static/data.txtnoch Potato/potatoData.txt...

Was vermisse ich?!

python package setuptools joaoricardo000
quelle

Antworten:

122

Wie in den Kommentaren erwähnt, gibt es zwei Möglichkeiten, die statischen Dateien hinzuzufügen:

1 - include_package_data = True + MANIFEST.in

Eine MANIFEST.inDatei im selben Verzeichnis setup.pysieht folgendermaßen aus:

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

Mit include_package_data = Truein setup.py.

2 - package_data in setup.py

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

Geben Sie die Dateien im an setup.py.

Verwenden Sie nicht beide include_package_dataund package_datain setup.py.

include_package_datamacht die package_dataInformationen ungültig .

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

joaoricardo000
quelle
3
Funktioniert! Anscheinend wählt MANIFEST.in die Dateien aus, die zusätzlich zu der Datei setup.py / distutils aufgenommen werden sollen.
Chbrown
13
Dies zu tun und das include_package_data = Trueoben Genannte hinzuzufügen, hat für mich funktioniert. Beides musste getan werden: Die Manifestdatei und die Anweisung setup.py.
djhaskin987
Ich füge nur "include * .txt" hinzu. Funktioniert großartig, danke
Priyeshj
7
Es sollte beachtet werden, dass Sie bei jeder Angabe include_package_data=Trueden Effekt von grundsätzlich aufheben. package_dataDeshalb erwarten setuptools, dass Sie Dateien in Ihre Datei aufnehmen MANIFEST.in. Verwenden Sie einen von ihnen ( package_datavs include_package_data=True+ MANIFEST.in), nicht beide.
Konoufo
Ist es möglich, zur Laufzeit in das statische Verzeichnis zu schreiben?
Haarige
28

Schließen Sie alle Dateien rekursiv ein:

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

Wo project_nameist ein Ordner in der gleichen Zeile, in der Sie setup.pyDatei haben.

Anton Danilchenko
quelle
1
Sie können auch eine einzelne Datei include funniest/data.json
Rodrigo Dias
11

Den Dokumenten zufolge gibt es drei Möglichkeiten , Paketdatendateien einzuschließen. Sie haben zwei Pakete: Kartoffel und Tomate. Das statische Verzeichnis befindet sich in keinem dieser Pakete. Aus diesem Grund funktionierte Ihr package_data-Wörterbuch in setup.py nicht. Die Manifest-Option erfordert, dass include_package_data in setup.py auf True gesetzt ist. Der Zugriff auf Nicht-Paket-Datendateien kann wie hier beschrieben erfolgen .

Emispowder
quelle
6

Verwenden Sie Folgendes

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

package_data={'templates':['*'],'static':['*'],'docs':['*'],},
Dadaso Zanzane
quelle
1
Dies könnte zu umfassend sein.
Acumenus