Come includere i dati del pacchetto con setuptools / distribut?

Quando si utilizzano setuptools / distribut, non riesco a ottenere il file di installazione da estrarre package_data. Tutto quello che ho letto dice che il seguente è il modo corretto di farlo. Qualcuno può avvisare per favore?

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

dove si myapp/data/trova la posizione dei file di dati.

Mi rendo conto che questa è una vecchia domanda, ma per le persone che si fanno strada qui tramite Google: package_dataè una bugia bassa e sporca . Viene utilizzato solo durante la creazione di pacchetti binari ( python setup.py bdist ...) ma non durante la creazione di pacchetti sorgente ( python setup.py sdist ...). Questo è, ovviamente, ridicolo - ci si aspetterebbe che la costruzione di una distribuzione di origine comporterebbe una raccolta di file che potrebbero essere inviati a qualcun altro per costruire la distribuzione binaria.

In ogni caso, l'utilizzo MANIFEST.infunzionerà sia per le distribuzioni binarie che per quelle di origine.

Ho appena avuto questo stesso problema. La soluzione era semplicemente quella di rimuoverla include_package_data=True.

Dopo aver letto qui , mi sono reso conto che include_package_datamira a includere i file dal controllo della versione , anziché limitarsi a "includere i dati del pacchetto", come suggerisce il nome. Dai documenti:

I file di dati [di include_package_data] devono essere sotto controllo CVS o Subversion

...

Se si desidera un controllo più preciso su quali file sono inclusi (ad esempio, se si hanno file di documentazione nelle directory dei pacchetti e si desidera escluderli dall'installazione), è possibile utilizzare anche la package_dataparola chiave.

L'eliminazione di tale argomento lo ha risolto, il che è per coincidenza il motivo per cui ha funzionato anche quando sei passato a distutils, dal momento che non accetta tale argomento.

Seguire la raccomandazione di @Joe di rimuovere la include_package_data=Truelinea ha funzionato anche per me.

Per elaborare un po 'di più, non ho alcun MANIFEST.in file. Uso Git e non CVS.

Il repository prende questo tipo di 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 sdistper un distributore di origine (non ho provato binario).

E quando sono all'interno di un nuovo ambiente virtuale, ho un myproject-4.19.tar.gzfile e lo uso

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

E oltre a tutto ciò che viene installato nel mio ambiente virtuale site-packages, questi file di dati speciali vengono installati su /opt/local/myproject/datae /opt/local/myproject/etc.

include_package_data=True ha funzionato per me.

Se usi git, ricordati di includerlo setuptools-gitin install_requires. Molto meno noioso di avere un Manifestpercorso incluso o incluso package_data(nel mio caso è un'app django con tutti i tipi di statica)

(incollato il commento che ho fatto, come ha detto k3-rnc , in realtà è utile così com'è)

Aggiornamento : questa risposta è vecchia e le informazioni non sono più valide. Tutte le configurazioni setup.py devono essere utilizzate import setuptools. Ho aggiunto una risposta più completa su https://stackoverflow.com/a/49501350/64313

Ho risolto questo passaggio passando a distutils. Sembra che la distribuzione sia obsoleta e / o danneggiata.

from distutils.core import setup

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

Domanda antica e tuttavia ... la gestione dei pacchetti di Python lascia davvero molto a desiderare. Quindi ho avuto il caso d'uso di installare pip usando localmente in una directory specificata e sono rimasto sorpreso che entrambi i percorsi package_data e data_files non abbiano funzionato. Non ero entusiasta di aggiungere ancora un altro file al repository, quindi ho finito per sfruttare l'opzione data_files e l'opzione setup.py --install-data; qualcosa come questo

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

Lo spostamento della cartella contenente i dati del pacchetto nella cartella del modulo ha risolto il problema per me.

Vedi questa domanda: MANIFEST.in ignorato su "python setup.py install" - nessun file di dati installato?

Ho avuto lo stesso problema per un paio di giorni, ma anche questo thread non è stato in grado di aiutarmi perché tutto era confuso. Quindi ho fatto le mie ricerche e ho trovato la seguente soluzione:

Fondamentalmente in questo caso, dovresti fare:

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'intero altro stackoverflow risponde qui

Basta rimuovere la linea:

include_package_data=True,

dal tuo script di installazione, e funzionerà bene. (Testato proprio ora con gli ultimi setuptools.)

Uso di setup.cfg (setuptools ≥ 30.3.0)

A partire da setuptools 30.3.0 (rilasciato il 08-12-2016), è possibile mantenere setup.pydimensioni molto ridotte e spostare la configurazione in un setup.cfgfile. Con questo approccio, è possibile inserire i dati del pacchetto in una [options.package_data]sezione:

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

In questo caso, setup.pypuoi essere breve quanto:

from setuptools import setup
setup()

Per ulteriori informazioni, vedere la configurazione di setup utilizzando i file setup.cfg .

Si parla di deprecaresetup.cfg a favore di pyproject.tomlquanto proposto nel PEP 518 , ma questo è ancora provvisorio a partire dal 2020-02-21.