Bagaimana cara memasukkan paket data dengan setuptools / mendistribusikan?

Saat menggunakan setuptools / distribusikan, saya tidak bisa mendapatkan installer untuk menarik package_datafile apa pun . Semua yang saya baca mengatakan bahwa berikut ini adalah cara yang benar untuk melakukannya. Bisakah seseorang memberi saran?

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

di mana myapp/data/lokasi file data.

Saya menyadari bahwa ini adalah pertanyaan lama, tetapi bagi orang-orang yang menemukan jalan mereka di sini melalui Google: package_dataadalah kebohongan yang rendah dan kotor . Ini hanya digunakan ketika membangun paket biner ( python setup.py bdist ...) tetapi tidak ketika membangun paket sumber ( python setup.py sdist ...). Ini, tentu saja, konyol - orang akan berharap bahwa membangun distribusi sumber akan menghasilkan kumpulan file yang dapat dikirim ke orang lain untuk membangun distribusi biner.

Bagaimanapun, menggunakan MANIFEST.inakan berfungsi baik untuk distribusi biner dan sumber.

Saya baru saja mengalami masalah yang sama. Solusinya, cukup dengan menghapus include_package_data=True.

Setelah membaca di sini , saya menyadari bahwa ini include_package_databertujuan untuk memasukkan file dari kontrol versi , bukan hanya "memasukkan data paket" seperti namanya. Dari dokumen:

File data [dari include_package_data] harus di bawah kendali CVS atau Subversion

...

Jika Anda ingin kontrol lebih halus atas file apa saja yang disertakan (misalnya, jika Anda memiliki file dokumentasi di direktori paket Anda dan ingin mengecualikannya dari instalasi), maka Anda juga dapat menggunakan package_datakata kunci.

Membuang argumen itu untuk memperbaikinya, yang merupakan alasan mengapa argumen ini juga berfungsi ketika Anda beralih ke distutils, karena argumen itu tidak menerima argumen itu.

Mengikuti rekomendasi @ Jo untuk menghapus include_package_data=Truesaluran juga bekerja untuk saya.

Untuk sedikit lebih rumit, saya tidak punya MANIFEST.infile. Saya menggunakan Git dan bukan CVS.

Repositori berbentuk seperti ini:

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

Saya menjalankan python setup.py sdistdistrib sumber (belum mencoba biner).

Dan ketika di dalam lingkungan virtual baru, saya punya myproject-4.19.tar.gz, file, dan saya gunakan

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

Dan selain semuanya yang diinstal ke lingkungan virtual saya site-packages, file data khusus itu diinstal ke /opt/local/myproject/datadan /opt/local/myproject/etc.

include_package_data=True bekerja untukku.

Jika Anda menggunakan git, ingat untuk menyertakan setuptools-gitdi install_requires. Jauh lebih tidak membosankan daripada memiliki Manifestatau memasukkan semua jalan masukpackage_data (dalam kasus saya ini adalah aplikasi Django dengan semua jenis statika)

(disisipkan komentar yang saya buat, seperti k3-rnc sebutkan itu sebenarnya membantu apa adanya)

Pembaruan : Jawaban ini sudah tua dan informasinya tidak lagi valid. Semua konfigurasi setup.py harus digunakan import setuptools. Saya telah menambahkan jawaban yang lebih lengkap di https://stackoverflow.com/a/49501350/64313

Saya memecahkan masalah ini dengan beralih ke distutils. Sepertinya mendistribusikan sudah usang dan / atau rusak.

from distutils.core import setup

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

Pertanyaan kuno namun ... manajemen paket python benar-benar menyisakan banyak yang diinginkan. Jadi saya punya kasus penggunaan menginstal menggunakan pip secara lokal ke direktori yang ditentukan dan terkejut kedua jalur package_data dan data_files tidak berhasil. Saya tidak tertarik untuk menambahkan file lain ke repo jadi saya akhirnya memanfaatkan data_files dan opsi setup.py - install-data; sesuatu seperti ini

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

Memindahkan folder yang berisi data paket ke folder modul memecahkan masalah bagi saya.

Lihat pertanyaan ini: MANIFEST.in diabaikan pada "python setup.py install" - tidak ada file data yang diinstal?

Saya memiliki masalah yang sama selama beberapa hari tetapi bahkan utas ini tidak dapat membantu saya karena semuanya membingungkan. Jadi saya melakukan riset dan menemukan solusi berikut:

Pada dasarnya dalam hal ini, Anda harus melakukan:

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

Jawaban lengkap stackoverflow lainnya di sini

Hapus saja garis:

include_package_data=True,

dari skrip pengaturan Anda, dan itu akan berfungsi dengan baik. (Diuji sekarang dengan alat setup terbaru.)

Menggunakan setup.cfg (setuptools ≥ 30.3.0)

Dimulai dengan setuptools 30.3.0 (dirilis 2016-12-08), Anda dapat menjaga setup.pysangat kecil dan memindahkan konfigurasi ke setup.cfgfile. Dengan pendekatan ini, Anda bisa meletakkan data paket Anda di [options.package_data]bagian:

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

Dalam hal ini, Anda setup.pydapat sesingkat:

from setuptools import setup
setup()

Untuk informasi lebih lanjut, lihat mengkonfigurasi pengaturan menggunakan file setup.cfg .

Ada beberapa pembicaraan tentang penghentiansetup.cfg mendukung pyproject.tomlseperti yang diusulkan dalam PEP 518 , tetapi ini masih bersifat sementara pada 2020-02-21.