Cómo incluir archivos estáticos en setuptools - paquete de python

83

Quiero incluir el ./static/data.txtto setuptools, aquí está mi código:

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

El sistema de archivos:

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

la salida cuando se ejecuta: 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)

¡y no se agregó txt! No static/data.txtni Potato/potatoData.txt...

¡¿Qué me estoy perdiendo?!

python package setuptools joaoricardo000
fuente

Respuestas:

123

Como se señaló en los comentarios, hay 2 formas de agregar los archivos estáticos:

1 - include_package_data = True + MANIFEST.in

Un MANIFEST.inarchivo en el mismo directorio setup.pyque se ve así:

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

Con include_package_data = Trueen setup.py.

2 - package_data en setup.py

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

Especifique los archivos dentro del setup.py.

No use ambos include_package_datay package_dataen setup.py.

include_package_dataanulará la package_datainformación.

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

joaoricardo000
fuente
3
¡Trabajos! Aparentemente, MANIFEST.in selecciona los archivos que se incluirán además de los que setup.py / distutils es lo suficientemente inteligente como para incluirlos por defecto.
chbrown
13
Hacer esto y agregar lo include_package_data = Trueanterior funcionó para mí. Ambos tenían que hacerse: el archivo de manifiesto y la directiva setup.py.
djhaskin987
Solo agrego "incluir * .txt". Funciona muy bien gracias
Priyeshj
7
Cabe señalar que, en cualquier momento que especifique include_package_data=True, básicamente anula el efecto de package_data, y es por eso que las herramientas de instalación esperan que incluya archivos en su MANIFEST.in. Use uno de ellos ( package_datavs include_package_data=True+ MANIFEST.in), no ambos.
konoufo
¿Es posible escribir en el directorio estático durante el tiempo de ejecución?
Hairy
28

Incluya todos los archivos de forma recursiva:

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

donde project_namees una carpeta en la misma línea donde tiene el setup.pyarchivo.

Anton Danilchenko
fuente
1
También puede incluir un solo archivo con: include funniest/data.jsonpor ejemplo
Rodrigo Dias
11

Según los documentos, hay tres formas de incluir archivos de datos de paquetes. Tienes dos paquetes: Papa y Tomate. El directorio estático no está en ninguno de esos paquetes, por eso su diccionario package_data en setup.py no estaba funcionando. La opción de manifiesto requiere que include_package_data esté establecido en True en setup.py. El acceso a los archivos de datos que no pertenecen al paquete se puede realizar de la forma que se encuentra aquí .

Emispowder
fuente
6

Utilice lo siguiente

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

package_data={'templates':['*'],'static':['*'],'docs':['*'],},
Dadaso Zanzane
fuente
1
Esto podría ser demasiado inclusivo.
Acumenus