Làm cách nào để đưa tệp giấy phép vào tập lệnh setup.py?

Question

Tôi đã viết một mô-đun mở rộng Python trong C++. Tôi định phân phối mô-đun với các công cụ thiết lập. Sẽ có bản phân phối nhị phân cho Windows 32 và 64 bit (được xây dựng với setup.py bdist_egg) và phân phối nguồn cho các nền tảng giống UNIX (được xây dựng với setup.py sdist).

Tôi định cấp phép mô-đun theo giấy phép BSD. Trong cây nguồn của tôi, tệp LICENSE.txt nằm trong thư mục trên cùng cùng với setup.py. Tôi nên bao gồm nó trong gói cài đặt như thế nào?

Tôi đã thử các script setup.py sau:

from setuptools import setup, Extension 
from glob import glob 

setup(
    name = 'Foo', 
    version = '0.1.0', 
    ext_modules = [Extension('Foo', glob('Source/*.cpp'))], 
    package_data = {'': ['LICENSE.txt']} 
) 

Nó không làm việc, các tệp giấy phép không bao gồm trong gói cài đặt. Có thể do tệp setup.py không xác định bất kỳ gói nào, chỉ một mô-đun tiện ích mở rộng.

Làm cách nào để khắc phục sự cố này?

Answer 1

Sử dụng data_files:

setup(
    name = "Foo", 
    version = "0.1.0", 
    ext_modules = [Extension("Foo", glob("Source/*.cpp"))], 
    data_files = [("", ["LICENSE.txt"])] 
) 

Hai nhận xét:

1. Không cần phải trực tiếp xuất xưởng một giấy phép với sản phẩm của bạn, bạn có thể sử dụng license metadata trong distutils chỉ định này.

2. Không sử dụng hỗn hợp đơn báo giá và hai dấu ngoặc kép trong mã của bạn :)

Answer 2

Ví dụ:

setup(
    ... 
    license="ZPL", 
    classifiers=[ 
     ... 
     'License :: OSI Approved :: Zope Public License', 
     ... 
     ], 
    ...) 

bổ sung bạn có thể chèn văn bản giấy phép của bạn vào 'long_description' :

setup(
    ... 
    long_description="Package description. \nLicense Text", 
    ...) 

Answer 3

Viết setup.cfg tệp và trong đó chỉ định:

[metadata] 
license_file = LICENSE.txt