Comment inclure des données de package avec setuptools / distribuer?

Lorsque j'utilise setuptools / distribuer, je ne peux pas demander au programme d'installation d'extraire des package_datafichiers. Tout ce que j'ai lu dit que ce qui suit est la bonne façon de le faire. Quelqu'un peut-il conseiller s'il vous plaît?

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

où myapp/data/est l'emplacement des fichiers de données.

Je me rends compte que c'est une vieille question, mais pour les gens qui trouvent leur chemin ici via Google: package_datac'est un mensonge bas et sale . Il n'est utilisé que lors de la construction de packages binaires ( python setup.py bdist ...) mais pas lors de la construction de packages sources ( python setup.py sdist ...). C'est, bien sûr, ridicule - on s'attendrait à ce que la construction d'une distribution source aboutisse à une collection de fichiers qui pourraient être envoyés à quelqu'un d'autre pour construire la distribution binaire.

Dans tous les cas, l'utilisation MANIFEST.infonctionnera à la fois pour les distributions binaires et sources.

J'ai juste eu ce même problème. La solution, était simplement de supprimer include_package_data=True.

Après avoir lu ici , j'ai réalisé que l' include_package_dataobjectif était d'inclure des fichiers à partir du contrôle de version , par opposition à simplement "inclure des données de package" comme son nom l'indique. À partir de la documentation:

Les fichiers de données [de include_package_data] doivent être sous contrôle CVS ou Subversion

...

Si vous souhaitez un contrôle plus fin sur les fichiers inclus (par exemple, si vous avez des fichiers de documentation dans les répertoires de vos packages et que vous souhaitez les exclure de l'installation), vous pouvez également utiliser le package_datamot - clé.

Retirer cet argument l'a corrigé, ce qui est par coïncidence pourquoi cela a également fonctionné lorsque vous êtes passé à distutils, car il ne prend pas cet argument.

Suivre la recommandation de @Joe de supprimer la include_package_data=Trueligne a également fonctionné pour moi.

Pour élaborer un peu plus, je n'ai pas de MANIFEST.in dossier. J'utilise Git et non CVS.

Le référentiel prend ce genre de forme:

/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...
        ], },
)

Je cours python setup.py sdistpour une distribution source (je n'ai pas essayé le binaire).

Et quand à l'intérieur d'un tout nouvel environnement virtuel, j'ai un myproject-4.19.tar.gzfichier et j'utilise

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

Et à part tout ce qui est installé dans mon environnement virtuel site-packages, ces fichiers de données spéciaux sont installés sur /opt/local/myproject/dataet /opt/local/myproject/etc.

include_package_data=True travaillé pour moi.

Si vous utilisez git, n'oubliez pas d'inclure setuptools-gitdans install_requires. Beaucoup moins ennuyeux que d'avoir un Manifestchemin ou d'inclure tous les chemins package_data(dans mon cas, c'est une application django avec toutes sortes de statiques)

(collé le commentaire que j'ai fait, comme k3-rnc l'a mentionné, il est en fait utile tel quel)

Mise à jour : Cette réponse est ancienne et les informations ne sont plus valides. Toutes les configurations setup.py doivent utiliser import setuptools. J'ai ajouté une réponse plus complète sur https://stackoverflow.com/a/49501350/64313

J'ai résolu ce problème en passant aux distutils. On dirait que distribuer est obsolète et / ou cassé.

from distutils.core import setup

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

Ancienne question et pourtant ... la gestion des paquets de python laisse vraiment à désirer. J'ai donc eu le cas d'utilisation de l'installation en utilisant pip localement dans un répertoire spécifié et j'ai été surpris que les chemins package_data et data_files ne fonctionnent pas. Je n'avais pas envie d'ajouter encore un autre fichier au référentiel, alors j'ai fini par tirer parti de l'option data_files et setup.py --install-data; quelque chose comme ça

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

Le déplacement du dossier contenant les données du package dans le dossier du module a résolu le problème pour moi.

Voir cette question: MANIFEST.in ignoré sur "python setup.py install" - aucun fichier de données installé?

J'ai eu le même problème pendant quelques jours, mais même ce fil n'a pas pu m'aider car tout était déroutant. J'ai donc fait mes recherches et trouvé la solution suivante:

Fondamentalement, dans ce cas, vous devez faire:

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'],
   },
)

L'autre réponse complète de stackoverflow ici

Supprimez simplement la ligne:

include_package_data=True,

à partir de votre script de configuration, et cela fonctionnera très bien. (Testé tout à l'heure avec les derniers setuptools.)

Utilisation de setup.cfg (setuptools ≥ 30.3.0)

À partir de setuptools 30.3.0 (publié le 08/12/2016), vous pouvez garder votre setup.pytout petit et déplacer la configuration dans un setup.cfgfichier. Avec cette approche, vous pouvez mettre les données de votre package dans une [options.package_data]section:

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

Dans ce cas, votre setup.pypeut être aussi court que:

from setuptools import setup
setup()

Pour plus d'informations, voir la configuration de l'installation à l'aide des fichiers setup.cfg .

On parle de dépréciersetup.cfg en faveur de pyproject.tomlcomme proposé dans la PEP 518 , mais cela reste provisoire à partir du 21/02/2020.