Bagaimana cara saya membuatnya setup.py menyertakan file yang bukan bagian dari kode? (Secara khusus, ini adalah file lisensi, tetapi bisa juga hal lain.)

Saya ingin dapat mengontrol lokasi file. Di folder sumber asli, file tersebut di root paket. (Yaitu pada tingkat yang sama dengan yang paling atas __init__.py.) Saya ingin tetap persis di sana ketika paket diinstal, terlepas dari sistem operasi. Bagaimana aku melakukan itu?

Mungkin cara terbaik untuk melakukan ini adalah dengan menggunakan setuptools package_dataarahan. Ini berarti menggunakan setuptools(atau distribute) alih-alih distutils, tetapi ini adalah "peningkatan" yang sangat mulus.

Berikut ini contoh lengkap (tetapi belum teruji):

from setuptools import setup, find_packages

setup(
    name='your_project_name',
    version='0.1',
    description='A description.',
    packages=find_packages(exclude=['ez_setup', 'tests', 'tests.*']),
    package_data={'': ['license.txt']},
    include_package_data=True,
    install_requires=[],
)

Perhatikan baris spesifik yang sangat penting di sini:

package_data={'': ['license.txt']},
include_package_data=True,

package_dataadalah dictnama paket (kosong = semua paket) ke daftar pola (dapat menyertakan gumpalan). Misalnya, jika Anda hanya ingin menentukan file di dalam paket Anda, Anda dapat melakukannya juga:

package_data={'yourpackage': ['*.txt', 'path/to/resources/*.txt']}

Solusinya di sini jelas bukan untuk mengganti nama non- pyfile Anda dengan a.py ekstensi.

Lihat presentasi Ian Bicking untuk info lebih lanjut.

UPDATE: Pendekatan [Lebih Baik] Lain

Pendekatan lain yang berfungsi dengan baik jika Anda hanya ingin mengontrol konten distribusi sumber ( sdist) dan memiliki file di luar paket (misalnya direktori tingkat atas) adalah menambahkan MANIFEST.infile. Lihat dokumentasi Python untuk format file ini.

Sejak menulis respons ini, saya telah menemukan bahwa menggunakan MANIFEST.inbiasanya merupakan pendekatan yang kurang membuat frustrasi untuk memastikan distribusi sumber Anda ( tar.gz) memiliki file yang Anda butuhkan.

Misalnya, jika Anda ingin memasukkan requirements.txtdari tingkat atas, secara rekursif sertakan direktori "data" tingkat atas:

include requirements.txt
recursive-include data *

Namun demikian, agar file-file ini dapat disalin pada waktu instalasi ke folder paket di dalam paket-situs, Anda harus menyediakan include_package_data=Trueke setup()fungsi tersebut. Lihat Menambahkan File Non-Kode untuk informasi lebih lanjut.

Untuk mencapai apa yang Anda gambarkan akan diperlukan dua langkah ...

• File perlu ditambahkan ke tarball sumber
• setup.py perlu dimodifikasi untuk menginstal file data ke jalur sumber

Langkah 1: Untuk menambahkan file ke tarball sumber, sertakan di MANIFEST

Buat template MANIFEST di folder yang berisi setup.py

MANIFEST pada dasarnya adalah file teks dengan daftar semua file yang akan dimasukkan dalam tarball sumber.

Seperti inilah tampilan MANIFEST untuk proyek saya:

• CHANGELOG.txt
• INSTALL.txt
• LICENSE.txt
• pypreprocessor.py
• README.txt
• setup.py
• test.py
• TODO.txt

Catatan: Sementara sdist tidak menambahkan beberapa file secara otomatis , saya lebih memilih untuk secara eksplisit menentukan mereka untuk memastikan bukannya memprediksi apa yang dilakukan dan tidak.

Langkah 2: Untuk menginstal file data ke folder sumber, ubah setup.py

Karena Anda ingin menambahkan file data (LICENSE.txt) ke folder instal sumber, Anda perlu memodifikasi jalur instal data agar sesuai dengan path instal sumber. Ini diperlukan karena, secara default, file data dipasang ke lokasi yang berbeda dari file sumber.

Untuk mengubah dir instalasi data agar sesuai dengan dir ...

Tarik info instal dir dari distutils dengan:

from distutils.command.install import INSTALL_SCHEMES

Ubah direktori pemasangan data agar sesuai dengan direktori pemasangan sumber:

for scheme in INSTALL_SCHEMES.values():
    scheme['data'] = scheme['purelib']

Dan, tambahkan file data dan lokasi ke setup ():

data_files=[('', ['LICENSE.txt'])]

Catatan: Langkah-langkah di atas harus mencapai apa yang Anda jelaskan dengan cara standar tanpa memerlukan pustaka ekstensi apa pun.

buat MANIFEST.indi root proyek dengan recursive-includeke direktori yang diperlukan atau includedengan nama file.

include LICENSE
include README.rst
recursive-include package/static *
recursive-include package/templates *

dokumentasi dapat ditemukan di sini

Saya ingin mengirim komentar ke salah satu pertanyaan tetapi saya tidak memiliki reputasi yang cukup untuk melakukan itu>.>

Inilah yang bekerja untuk saya (muncul setelah merujuk dokumen):

package_data={
    'mypkg': ['../*.txt']
},

include_package_data: False

Baris terakhir, anehnya, juga penting bagi saya (Anda juga dapat menghilangkan argumen kata kunci ini - kerjanya sama).

Apa yang dilakukan adalah menyalin semua file teks di direktori tingkat atas atau root Anda (satu tingkat lebih tinggi dari paket mypkg yang ingin Anda bagikan).

Semoga ini membantu!

Langkah 1: buat MANIFEST.infile di folder yang sama dengan setup.py

Langkah 2: sertakan jalur relatif ke file yang ingin Anda tambahkanMANIFEST.in

include README.rst
include docs/*.txt
include funniest/data.json

Langkah 3: atur include_package_data=Truedalam setup()fungsi untuk menyalin file-file ini ke paket situs

Referensi ada di sini.

Ini tahun 2019, dan inilah yang berfungsi - meskipun ada saran di sana-sini, apa yang saya temukan di internet setengah didokumentasikan menggunakan setuptools_scm, disahkan sebagai opsi untuksetuptools.setup . Ini akan mencakup semua file data yang diversi pada VCS Anda, baik itu git atau yang lain, ke paket roda, dan akan membuat "pip install" dari repositori git untuk membawa file-file itu.

Jadi, saya baru saja menambahkan dua baris ini ke panggilan pengaturan pada "setup.py". Tidak diperlukan pemasangan atau impor tambahan:

    setup_requires=['setuptools_scm'],
    include_package_data=True,

Tidak perlu mendaftar secara manual package_data, atau dalam file MANIFEST.in - jika sudah diversi, itu sudah termasuk dalam paket. Dokumen pada "setuptools_scm" menekankan pada pembuatan nomor versi dari posisi komit, dan mengabaikan bagian yang sangat penting dari menambahkan file data. (Saya tidak peduli jika file roda perantara saya dinamai "* 0.2.2.dev45 + g3495a1f" atau akan menggunakan nomor versi hardcoded "0.3.0dev0" yang saya ketikkan - tetapi meninggalkan file penting untuk program agar kerja di belakang agak penting)

Di setup.py di bawah pengaturan (:

setup(
   name = 'foo library'
   ...
  package_data={
   'foolibrary.folderA': ['*'],     # All files from folder A
   'foolibrary.folderB': ['*.txt']  #All text files from folder B
   },

Ini jawaban sederhana yang berhasil buat saya.

Pertama, sesuai komentar Python Dev di atas, setuptools tidak diperlukan:

package_data is also available to pure distutils setup scripts 
since 2.3. – Éric Araujo

Itu bagus karena meletakkan persyaratan setuptools pada paket Anda berarti Anda harus menginstalnya juga. Pendeknya:

from distutils.core import setup

setup(
    # ...snip...
    packages          = ['pkgname'],
    package_data      = {'pkgname': ['license.txt']},
)

Saya hanya ingin menindaklanjuti sesuatu yang saya temukan bekerja dengan Python 2.7 pada Centos 6. Menambahkan package_data atau data_files seperti yang disebutkan di atas tidak bekerja untuk saya. Saya menambahkan MANIFEST.IN dengan file yang saya inginkan yang meletakkan file non-python ke tarball, tetapi tidak menginstalnya pada mesin target melalui RPM.

Pada akhirnya, saya bisa memasukkan file ke dalam solusi saya menggunakan "opsi" di setup / setuptools. File opsi memungkinkan Anda memodifikasi berbagai bagian file spesifikasi dari setup.py. Sebagai berikut.

from setuptools import setup


setup(
    name='theProjectName',
    version='1',
    packages=['thePackage'],
    url='',
    license='',
    author='me',
    author_email='[email protected]',
    description='',
    options={'bdist_rpm': {'install_script': 'filewithinstallcommands'}},
)

file - MANIFEST.in:

include license.txt

file - filewengan perintah instal:

mkdir -p $RPM_BUILD_ROOT/pathtoinstall/
#this line installs your python files
python setup.py install -O1 --root=$RPM_BUILD_ROOT --record=INSTALLED_FILES
#install license.txt into /pathtoinstall folder
install -m 700 license.txt $RPM_BUILD_ROOT/pathtoinstall/
echo /pathtoinstall/license.txt >> INSTALLED_FILES

Menemukan solusi: Saya mengganti nama saya lgpl2.1_license.txtmenjadi lgpl2.1_license.txt.py, dan menaruh beberapa tanda kutip di sekitar teks. Sekarang saya tidak perlu menggunakan data_filesopsi atau untuk menentukan jalur absolut. Membuatnya modul Python jelek, saya tahu, tapi saya menganggapnya kurang jelek daripada menentukan jalur absolut.