ฉันจะทำอย่างไร setup.pyรวมไฟล์ที่ไม่ได้เป็นส่วนหนึ่งของรหัสได้อย่างไร (โดยเฉพาะมันเป็นไฟล์ลิขสิทธิ์ แต่อาจเป็นอย่างอื่นก็ได้)

ฉันต้องการที่จะควบคุมตำแหน่งของไฟล์ ในโฟลเดอร์ต้นฉบับต้นฉบับไฟล์อยู่ในรูทของแพ็คเกจ (เช่นในระดับเดียวกับระดับสูงสุด__init__.py) ฉันต้องการให้มันอยู่ตรงนั้นเมื่อติดตั้งแพ็คเกจโดยไม่คำนึงถึงระบบปฏิบัติการ ฉันจะทำอย่างไร

อาจเป็นวิธีที่ดีที่สุดในการทำเช่นนี้คือการใช้setuptools package_dataคำสั่ง นี่หมายถึงการใช้setuptools(หรือdistribute) แทนdistutilsแต่นี่เป็น "การอัพเกรด" ที่ราบรื่นมาก

นี่คือตัวอย่างเต็มรูปแบบ (แต่ยังไม่ทดลอง):

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=[],
)

สังเกตบรรทัดเฉพาะที่สำคัญตรงนี้:

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

package_dataเป็นdictชื่อแพ็คเกจ (ว่าง = แพ็คเกจทั้งหมด) ไปยังรายการรูปแบบ (สามารถรวม globs) ตัวอย่างเช่นหากคุณต้องการระบุเฉพาะไฟล์ภายในแพ็คเกจของคุณคุณสามารถทำได้เช่นกัน:

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

วิธีแก้ปัญหาที่นี่คือไม่เปลี่ยนชื่อpyไฟล์ที่ไม่ใช่ของคุณด้วย.pyนามสกุล

ดูการนำเสนอของ Ian Bickingสำหรับข้อมูลเพิ่มเติม

อัปเดต: วิธีการ [ดีกว่า] อีกวิธีหนึ่ง

วิธีการอื่นที่ใช้งานได้ดีหากคุณต้องการควบคุมเนื้อหาของการแจกจ่ายซอร์ส ( sdist) และมีไฟล์นอกแพ็คเกจ (เช่นไดเรกทอรีระดับบนสุด) คือการเพิ่มMANIFEST.inไฟล์ ดูเอกสาร Pythonสำหรับรูปแบบของไฟล์นี้

ตั้งแต่เขียนคำตอบนี้ฉันพบว่าการใช้โดยMANIFEST.inทั่วไปแล้วเป็นวิธีที่น่าผิดหวังน้อยกว่าเพื่อให้แน่ใจว่าการกระจายแหล่งที่มาของคุณ (tar.gz ) มีไฟล์ที่คุณต้องการ

ตัวอย่างเช่นหากคุณต้องการรวมrequirements.txtจากระดับบนสุดให้รวมไดเรกทอรี "data" ระดับบนสุดซ้ำ:

include requirements.txt
recursive-include data *

อย่างไรก็ตามในการที่จะคัดลอกไฟล์เหล่านี้ในเวลาติดตั้งไปยังโฟลเดอร์ของแพ็คเกจภายในไซต์แพ็คเกจคุณจะต้องส่งinclude_package_data=Trueไปยังsetup()ฟังก์ชัน ดูการเพิ่มไฟล์ที่ไม่ใช่รหัสสำหรับข้อมูลเพิ่มเติม

ในการบรรลุสิ่งที่คุณอธิบายจะใช้สองขั้นตอน ...

• ไฟล์จะต้องเพิ่มไปยังแหล่ง tarball
• จำเป็นต้องได้รับการแก้ไข setup.py เพื่อติดตั้งไฟล์ข้อมูลไปยังเส้นทางต้นทาง

ขั้นตอนที่ 1: ในการเพิ่มไฟล์ลงใน tarball ต้นทางให้รวมไว้ใน MANIFEST

สร้างMANIFESTเทมเพลตในโฟลเดอร์ที่มี setup.py

รายการนั้นเป็นไฟล์ข้อความที่มีรายชื่อของไฟล์ทั้งหมดที่จะรวมอยู่ในแหล่ง tarball

นี่คือลักษณะที่ปรากฏสำหรับโครงการของฉัน:

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

หมายเหตุ: แม้ว่าsdist จะเพิ่มไฟล์บางไฟล์โดยอัตโนมัติแต่ฉันต้องการระบุให้ชัดเจนเพื่อให้แน่ใจว่าจะไม่คาดเดาว่ามันทำอะไรและไม่ได้

ขั้นตอนที่ 2: ในการติดตั้งไฟล์ข้อมูลไปยังโฟลเดอร์แหล่งข้อมูลให้แก้ไข setup.py

เนื่องจากคุณต้องการเพิ่มไฟล์ข้อมูล (LICENSE.txt) ในโฟลเดอร์การติดตั้งซอร์สคุณต้องแก้ไขพา ธ การติดตั้งข้อมูลเพื่อให้ตรงกับพา ธ การติดตั้งต้นทาง สิ่งนี้จำเป็นเพราะโดยปกติแล้วไฟล์ข้อมูลจะถูกติดตั้งในตำแหน่งที่แตกต่างจากไฟล์ต้นฉบับ

หากต้องการแก้ไขข้อมูลการติดตั้ง dir ให้ตรงกับแหล่งข้อมูลการติดตั้ง ...

ดึงข้อมูลการติดตั้งจาก distutils ด้วย:

from distutils.command.install import INSTALL_SCHEMES

ปรับเปลี่ยน dir การติดตั้งข้อมูลเพื่อให้ตรงกับ dir ติดตั้งแหล่งที่มา:

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

และเพิ่มไฟล์ข้อมูลและตำแหน่งเพื่อตั้งค่า ():

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

หมายเหตุ: ขั้นตอนข้างต้นควรบรรลุสิ่งที่คุณอธิบายในลักษณะมาตรฐานโดยไม่ต้องใช้ไลบรารีส่วนขยายใด ๆ

สร้างMANIFEST.inในรูทโปรเจ็กต์recursive-includeไปยังไดเร็กทอรีที่ต้องการหรือincludeด้วยชื่อไฟล์

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

เอกสารสามารถพบได้ที่นี่

ฉันต้องการโพสต์ความคิดเห็นในคำถามใดคำถามหนึ่ง แต่ฉันไม่มีชื่อเสียงพอที่จะทำเช่นนั้น>.>

นี่คือสิ่งที่ใช้งานได้สำหรับฉัน (เกิดขึ้นหลังจากอ้างอิงเอกสาร):

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

include_package_data: False

บรรทัดสุดท้ายนั้นแปลกมากและสำคัญสำหรับฉันเช่นกัน (คุณสามารถละเว้นอาร์กิวเมนต์คำหลักนี้ - มันใช้งานได้เหมือนกัน)

สิ่งนี้จะทำอย่างไรก็อปปี้ไฟล์ข้อความทั้งหมดในไดเรกทอรีระดับบนสุดหรือรูทไดเร็กทอรี (หนึ่งระดับขึ้นจากแพ็คเกจที่mypkgคุณต้องการแจกจ่าย)

หวังว่านี่จะช่วยได้!

ขั้นตอนที่ 1:สร้างMANIFEST.inไฟล์ในโฟลเดอร์เดียวกันด้วย setup.py

ขั้นตอนที่ 2:รวมเส้นทางสัมพันธ์ไปยังไฟล์ที่คุณต้องการเพิ่มMANIFEST.in

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

ขั้นตอนที่ 3:ตั้งค่าinclude_package_data=Trueในsetup()ฟังก์ชันเพื่อคัดลอกไฟล์เหล่านี้ไปยังไซต์แพ็คเกจ

การอ้างอิงอยู่ที่นี่

มันคือ 2019 และนี่คือสิ่งที่ทำงาน - แม้จะมีคำแนะนำที่นี่และที่นั่นสิ่งที่ฉันพบบนอินเทอร์เน็ตมีการใช้เอกสารครึ่งทางsetuptools_scmผ่านเป็นตัวเลือกsetuptools.setupจ่ายบอลสำเร็จเป็นตัวเลือกในการ ซึ่งจะรวมถึงไฟล์ข้อมูลใด ๆ ที่เป็นเวอร์ชันใน VCS ของคุณไม่ว่าจะเป็นคอมไพล์หรืออื่น ๆ ไปยังแพ็คเกจล้อและจะทำการ "ติดตั้ง pip" จากที่เก็บ git เพื่อนำไฟล์เหล่านั้นไปด้วย

ดังนั้นฉันเพิ่งเพิ่มสองบรรทัดนี้ในการเรียกใช้การตั้งค่าที่ "setup.py" ไม่จำเป็นต้องติดตั้งหรือนำเข้าเพิ่มเติม:

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

ไม่จำเป็นต้องแสดงรายการ package_data ด้วยตนเองหรือในไฟล์ MANIFEST.in - หากเป็นเวอร์ชั่นจะรวมอยู่ในแพ็คเกจ เอกสารใน "setuptools_scm" ให้ความสำคัญกับการสร้างหมายเลขเวอร์ชันจากตำแหน่งการส่งมอบและไม่สนใจส่วนที่สำคัญจริงๆของการเพิ่มไฟล์ข้อมูล (ฉันไม่สนหรอกถ้าไฟล์วงล้อกลางของฉันชื่อ "* 0.2.2.dev45 + g3495a1f" หรือจะใช้หมายเลขเวอร์ชัน hardcoded "0.3.0dev0" ที่ฉันได้พิมพ์ - แต่ปล่อยให้ไฟล์สำคัญสำหรับโปรแกรม การทำงานเบื้องหลังเป็นสิ่งสำคัญ)

ใน setup.py ภายใต้การตั้งค่า (:

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

นี่เป็นคำตอบที่ง่ายกว่าสำหรับฉัน

ก่อนอื่นตามความเห็นของ Python Dev ข้างต้นไม่จำเป็นต้องใช้ setuptools:

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

เยี่ยมมากเพราะการวางข้อกำหนด setuptools ลงบนแพ็คเกจของคุณหมายความว่าคุณจะต้องติดตั้งด้วย ในระยะสั้น:

from distutils.core import setup

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

ฉันแค่อยากติดตามบางสิ่งที่ฉันพบว่าทำงานกับ Python 2.7 บน Centos 6 การเพิ่ม package_data หรือ data_files ตามที่กล่าวไว้ข้างต้นไม่ได้ผลสำหรับฉัน ฉันเพิ่ม MANIFEST.IN พร้อมไฟล์ที่ฉันต้องการซึ่งวางไฟล์ที่ไม่ใช่ไพ ธ อนลงใน tarball แต่ไม่ได้ติดตั้งไว้ในเครื่องเป้าหมายผ่าน RPM

ในที่สุดฉันก็สามารถนำไฟล์เข้าสู่โซลูชันของฉันโดยใช้ "ตัวเลือก" ในการตั้งค่า / setuptools ไฟล์ตัวเลือกให้คุณแก้ไขส่วนต่าง ๆ ของไฟล์ข้อมูลจำเพาะจาก setup.py ดังนี้

from setuptools import setup


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

ไฟล์ - MANIFEST.in:

include license.txt

ไฟล์ - คำสั่ง filewithinstall:

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

คิดวิธีแก้ปัญหา: ฉันเปลี่ยนชื่อฉันlgpl2.1_license.txtเป็นlgpl2.1_license.txt.pyและใส่เครื่องหมายคำพูดสามรอบข้อความ ตอนนี้ฉันไม่จำเป็นต้องใช้data_filesตัวเลือกหรือเพื่อระบุเส้นทางที่แน่นอน ทำให้เป็นโมดูล Python น่าเกลียดฉันรู้ แต่ฉันคิดว่ามันน่าเกลียดน้อยกว่าการระบุพา ธ สัมบูรณ์