¿Cómo incluir el archivo de licencia en la secuencia de comandos setup.py?

Question

He escrito un módulo de extensión de Python en C++. Planeo distribuir el módulo con setuptools. Habrá distribuciones binarias para Windows de 32 y 64 bits (compiladas con setup.py bdist_egg) y una distribución fuente para plataformas tipo UNIX (compiladas con setup.py sdist).

Planeo licenciar el módulo bajo la licencia BSD. En mi árbol de fuentes, el archivo LICENSE.txt está en la carpeta superior junto con setup.py. ¿Cómo debería incluirlo en el paquete de instalación?

He probado el siguiente 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']} 
) 

No funcionó, el archivo de licencia no está incluido en el paquete de instalación. Tal vez porque el archivo setup.py no define ningún paquete, solo un módulo de extensión único.

¿Cómo puedo solucionar esto?

Answer 1

Uso data_files:

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

Dos observaciones:

1. No hay necesidad directa para enviar una licencia con el producto, se puede utilizar el license metadata en distutils para especificar esto.

2. No utilice mixta comilla simple y dobles comillas en el código :)

Answer 2

Por ejemplo:

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

Adicionalmente, puede agregar el texto de licencia en 'long_description' :

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

Answer 3

escribir un archivo setup.cfg y allí se especifica:

[metadata] 
license_file = LICENSE.txt