Come includere il file di licenza nello script setup.py?

Question

Ho scritto un modulo di estensione Python in C++. Ho intenzione di distribuire il modulo con setuptools. Ci saranno distribuzioni binarie per Windows a 32 e 64 bit (compilate con setup.py bdist_egg) e una distribuzione di origine per piattaforme simili a UNIX (create con setup.py sdist).

Ho intenzione di concedere in licenza il modulo sotto la licenza BSD. Nel mio albero dei sorgenti, il file LICENSE.txt si trova nella cartella superiore insieme a setup.py. Come dovrei includerlo nel pacchetto di installazione?

Ho provato il seguente script setup.py:

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

Non ha funzionato, il file di licenza non è incluso nel pacchetto di installazione. Forse perché il file setup.py non definisce alcun pacchetto, solo un singolo modulo di estensione.

Come posso risolvere questo problema?

Answer 1

Uso data_files:

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

Due osservazioni:

1. Non c'è bisogno diretta di spedire una licenza con il prodotto, è possibile utilizzare il license metadata in distutils per specificare questo.

2. Non utilizzare mista single-citazione e virgolette nel codice :)

Answer 2

Ad esempio:

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

Inoltre è possibile inserire il testo della licenza in 'long_description' :

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

Answer 3

scrivere un file setup.cfg e in là specificare:

[metadata] 
license_file = LICENSE.txt