¿Cómo incluir los datos del paquete con setuptools / distribution?

Cuando uso setuptools / distribution, no puedo hacer que el instalador extraiga ningún package_dataarchivo. Todo lo que he leído dice que la siguiente es la forma correcta de hacerlo. ¿Alguien puede aconsejarme?

setup(
   name='myapp',
   packages=find_packages(),
   package_data={
      'myapp': ['data/*.txt'],
   },
   include_package_data=True,
   zip_safe=False,
   install_requires=['distribute'],
)

donde myapp/data/es la ubicación de los archivos de datos.

Me doy cuenta de que esta es una vieja pregunta, pero para las personas que encuentran su camino aquí a través de Google: package_dataes una mentira sucia . Solo se usa al construir paquetes binarios ( python setup.py bdist ...) pero no cuando se compilan paquetes fuente ( python setup.py sdist ...). Esto es, por supuesto, ridículo: uno esperaría que construir una distribución de origen resultaría en una colección de archivos que podrían enviarse a otra persona para construir la distribución binaria.

En cualquier caso, el uso MANIFEST.infuncionará tanto para binarios como para distribuciones de origen.

Acabo de tener este mismo problema. La solución, era simplemente eliminar include_package_data=True.

Después de leer aquí , me di cuenta de que el include_package_dataobjetivo es incluir archivos del control de versiones , en lugar de simplemente "incluir datos del paquete" como su nombre lo indica. De los documentos:

Los archivos de datos [de include_package_data] deben estar bajo control CVS o Subversion

...

Si desea un control más detallado sobre qué archivos están incluidos (por ejemplo, si tiene archivos de documentación en los directorios de su paquete y desea excluirlos de la instalación), también puede usar la package_datapalabra clave.

Eliminar ese argumento lo solucionó, lo cual es coincidencia por qué también funcionó cuando cambiaste a distutils, ya que no toma ese argumento.

Seguir las recomendaciones de @Joe para eliminar la include_package_data=Truelínea también funcionó para mí.

Para elaborar un poco más, no tengo ningún MANIFEST.in archivo. Yo uso Git y no CVS.

El repositorio toma este tipo de forma:

/myrepo
    - .git/
    - setup.py
    - myproject
        - __init__.py
        - some_mod
            - __init__.py
            - animals.py
            - rocks.py
        - config
            - __init__.py
            - settings.py
            - other_settings.special
            - cool.huh
            - other_settings.xml
        - words
            - __init__.py
            word_set.txt

setup.py:

from setuptools import setup, find_packages
import os.path

setup (
    name='myproject',
    version = "4.19",
    packages = find_packages(),  
    # package_dir={'mypkg': 'src/mypkg'},  # didnt use this.
    package_data = {
        # If any package contains *.txt or *.rst files, include them:
        '': ['*.txt', '*.xml', '*.special', '*.huh'],
    },

#
    # Oddly enough, include_package_data=True prevented package_data from working.
    # include_package_data=True, # Commented out.
    data_files=[
#               ('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
        ('/opt/local/myproject/etc', ['myproject/config/settings.py', 'myproject/config/other_settings.special']),
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'cool.huh')]),
#
        ('/opt/local/myproject/etc', [os.path.join('myproject/config', 'other_settings.xml')]),
        ('/opt/local/myproject/data', [os.path.join('myproject/words', 'word_set.txt')]),
    ],

    install_requires=[ 'jsonschema',
        'logging', ],

     entry_points = {
        'console_scripts': [
            # Blah...
        ], },
)

Corro python setup.py sdistpor una fuente de distribución (no he probado binario).

Y cuando estoy dentro de un nuevo entorno virtual, tengo un myproject-4.19.tar.gzarchivo y uso

(venv) pip install ~/myproject-4.19.tar.gz
...

Y aparte de todo lo que se instala en mi entorno virtual site-packages, esos archivos de datos especiales se instalan en /opt/local/myproject/datay /opt/local/myproject/etc.

include_package_data=True trabajó para mi.

Si usa git, recuerde incluirlo setuptools-giten install_requires. Mucho menos aburrido que tener una Manifestruta o incluirla package_data(en mi caso, es una aplicación django con todo tipo de estadísticas)

(pegué el comentario que hice, ya que k3-rnc mencionó que en realidad es útil como es)

Actualización : esta respuesta es antigua y la información ya no es válida. Todas las configuraciones de setup.py deben usar import setuptools. Agregué una respuesta más completa en https://stackoverflow.com/a/49501350/64313

Resolví esto cambiando a distutils. Parece que distribuir está obsoleto y / o roto.

from distutils.core import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_data={
      'myapp': ['data/*.txt'],
   },
)

Antigua pregunta y sin embargo ... la gestión de paquetes de python realmente deja mucho que desear. Así que tuve el caso de uso de instalar pip localmente en un directorio específico y me sorprendió que las rutas package_data y data_files no funcionaran. No estaba interesado en agregar otro archivo al repositorio, así que terminé aprovechando data_files y la opción setup.py --install-data; algo como esto

pip install . --install-option="--install-data=$PWD/package" -t package  

Mover la carpeta que contiene los datos del paquete a la carpeta del módulo resolvió el problema para mí.

Vea esta pregunta: MANIFEST.in ignorado en "python setup.py install" - ¿no hay archivos de datos instalados?

Tuve el mismo problema durante un par de días, pero incluso este hilo no pudo ayudarme, ya que todo era confuso. Así que hice mi investigación y encontré la siguiente solución:

Básicamente en este caso, debes hacer:

from setuptools import setup

setup(
   name='myapp',
   packages=['myapp'],
   package_dir={'myapp':'myapp'}, # the one line where all the magic happens
   package_data={
      'myapp': ['data/*.txt'],
   },
)

La otra respuesta completa de stackoverflow aquí

Simplemente elimine la línea:

include_package_data=True,

desde su script de configuración, y funcionará bien. (Probado ahora con las últimas herramientas de configuración).

Usando setup.cfg (setuptools ≥ 30.3.0)

A partir de setuptools 30.3.0 (publicado el 12/12/2016), puede mantener su setup.pymuy pequeño y mover la configuración a un setup.cfgarchivo. Con este enfoque, puede poner los datos de su paquete en una [options.package_data]sección:

[options.package_data]
* = *.txt, *.rst
hello = *.msg

En este caso, setup.pypuede ser tan corto como:

from setuptools import setup
setup()

Para obtener más información, consulte la configuración de la instalación utilizando los archivos setup.cfg .

Se habla de menospreciarsetup.cfg a favor de pyproject.tomllo propuesto en PEP 518 , pero esto todavía es provisional a partir de 2020-02-21.