Comment puis-je faire setup.pyinclure un fichier qui ne fait pas partie du code? (Plus précisément, c'est un fichier de licence, mais cela pourrait être autre chose.)

Je veux pouvoir contrôler l'emplacement du fichier. Dans le dossier source d'origine, le fichier se trouve à la racine du package. (c'est-à-dire au même niveau que le plus haut __init__.py.) Je veux qu'il reste exactement là lorsque le package est installé, quel que soit le système d'exploitation. Comment je fais ça?

La meilleure façon de procéder est probablement d'utiliser la setuptools package_datadirective. Cela signifie utiliser setuptools(ou distribute) au lieu de distutils, mais il s'agit d'une "mise à niveau" très transparente.

Voici un exemple complet (mais non testé):

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

Notez les lignes spécifiques qui sont essentielles ici:

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

package_dataest un nom dictde package (vide = tous les packages) à une liste de modèles (peut inclure des globes). Par exemple, si vous souhaitez uniquement spécifier des fichiers dans votre package, vous pouvez également le faire:

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

La solution ici est définitivement de ne pas renommer vos non- pyfichiers avec une .pyextension.

Voir la présentation de Ian Bicking pour plus d'informations.

MISE À JOUR: Une autre [meilleure] approche

Une autre approche qui fonctionne bien si vous souhaitez simplement contrôler le contenu de la distribution source ( sdist) et avoir des fichiers en dehors du package (par exemple, le répertoire de niveau supérieur) consiste à ajouter un MANIFEST.infichier. Voir la documentation Python pour le format de ce fichier.

Depuis la rédaction de cette réponse, j'ai constaté que l'utilisation MANIFEST.inest généralement une approche moins frustrante pour s'assurer que votre distribution source ( tar.gz) possède les fichiers dont vous avez besoin.

Par exemple, si vous souhaitez inclure le à requirements.txtpartir du niveau supérieur, incluez récursivement le répertoire "données" de niveau supérieur:

include requirements.txt
recursive-include data *

Néanmoins, pour que ces fichiers soient copiés au moment de l'installation dans le dossier du package à l'intérieur de site-packages, vous devrez fournir include_package_data=Truela setup()fonction. Voir Ajout de fichiers non codés pour plus d'informations.

Pour accomplir ce que vous décrivez, il faudra deux étapes ...

• Le fichier doit être ajouté à l'archive tar source
• setup.py doit être modifié pour installer le fichier de données sur le chemin source

Étape 1: pour ajouter le fichier à l'archive tar source, incluez-le dans le MANIFEST

Créez un modèle MANIFEST dans le dossier qui contient setup.py

Le MANIFEST est essentiellement un fichier texte avec une liste de tous les fichiers qui seront inclus dans l'archive tar source.

Voici à quoi ressemble le MANIFEST pour mon projet:

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

Note: Bien que sdist n'ajouter quelques fichiers automatiquement , je préfère les spécifier explicitement pour être sûr au lieu de prédire ce qu'il fait et ne fonctionne pas.

Étape 2: pour installer le fichier de données dans le dossier source, modifiez setup.py

Puisque vous cherchez à ajouter un fichier de données (LICENSE.txt) au dossier d'installation source, vous devez modifier le chemin d'installation des données pour qu'il corresponde au chemin d'installation source. Cela est nécessaire car, par défaut, les fichiers de données sont installés à un emplacement différent de celui des fichiers source.

Pour modifier le répertoire d'installation des données afin qu'il corresponde au répertoire d'installation source ...

Tirez les informations du répertoire d'installation de distutils avec:

from distutils.command.install import INSTALL_SCHEMES

Modifiez le répertoire d'installation des données pour qu'il corresponde au répertoire d'installation source:

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

Et, ajoutez le fichier de données et l'emplacement à setup ():

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

Remarque: Les étapes ci-dessus doivent accomplir exactement ce que vous avez décrit de manière standard sans nécessiter de bibliothèques d'extension.

créer MANIFEST.inà la racine du projet avec recursive-includele répertoire requis ou includeavec le nom du fichier.

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

la documentation peut être trouvée ici

Je voulais poster un commentaire sur l'une des questions mais je n'ai pas assez de réputation pour le faire>.>

Voici ce qui a fonctionné pour moi (je l'ai trouvé après avoir référé les documents):

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

include_package_data: False

La dernière ligne était, étrangement, également cruciale pour moi (vous pouvez également omettre cet argument de mot clé - cela fonctionne de la même manière).

Ce qu'il fait, c'est qu'il copie tous les fichiers texte dans votre répertoire racine ou racine (un niveau au-dessus du package que mypkgvous souhaitez distribuer).

J'espère que cela t'aides!

Nous sommes en 2019, et voici ce qui fonctionne - malgré les conseils ici et là, ce que j'ai trouvé sur Internet à mi-chemin documenté utilise setuptools_scm, transmis en tant qu'options setuptools.setup. Cela inclura tous les fichiers de données qui sont versionnés sur votre VCS, que ce soit git ou tout autre, dans le paquetage wheel, et fera "pip install" à partir du référentiel git pour apporter ces fichiers.

Donc, je viens d'ajouter ces deux lignes à l'appel de configuration sur "setup.py". Aucune installation supplémentaire ou importation requise:

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

Pas besoin de lister manuellement package_data, ou dans un fichier MANIFEST.in - s'il est versionné, il est inclus dans le package. Les documents sur "setuptools_scm" mettent l'accent sur la création d'un numéro de version à partir de la position de validation, et ignorent la partie vraiment importante de l'ajout des fichiers de données. (Je m'en fiche si mon fichier de roue intermédiaire est nommé "* 0.2.2.dev45 + g3495a1f" ou utilisera le numéro de version codé en dur "0.3.0dev0" que j'ai tapé - mais en laissant des fichiers cruciaux au programme pour travailler derrière est quelque peu important)

Étape 1: créez un MANIFEST.infichier dans le même dossier avec setup.py

Étape 2: inclure le chemin d'accès relatif aux fichiers que vous souhaitez ajouterMANIFEST.in

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

Étape 3: définissez include_package_data=Truela setup()fonction pour copier ces fichiers dans site-package

La référence est ici.

Dans setup.py sous setup (:

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

Voici une réponse plus simple qui a fonctionné pour moi.

Tout d'abord, selon le commentaire d'un développeur Python ci-dessus, setuptools n'est pas requis:

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

C'est génial car mettre une exigence setuptools sur votre package signifie que vous devrez également l'installer. En bref:

from distutils.core import setup

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

Je voulais juste faire un suivi sur quelque chose que j'ai trouvé en travaillant avec Python 2.7 sur Centos 6. L'ajout des packages_data ou data_files comme mentionné ci-dessus n'a pas fonctionné pour moi. J'ai ajouté un MANIFEST.IN avec les fichiers que je voulais qui mettaient les fichiers non-python dans l'archive tar, mais je ne les ai pas installés sur la machine cible via RPM.

Au final, j'ai pu récupérer les fichiers dans ma solution en utilisant les "options" du setup / setuptools. Les fichiers d'options vous permettent de modifier différentes sections du fichier de spécifications à partir de setup.py. Comme suit.

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

fichier - MANIFEST.in:

include license.txt

file - filewithinstallcommands:

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

J'ai trouvé une solution de contournement: j'ai renommé mon lgpl2.1_license.txten lgpl2.1_license.txt.pyet j'ai mis des triples guillemets autour du texte. Maintenant, je n'ai plus besoin d'utiliser l' data_filesoption ni de spécifier de chemins absolus. En faire un module Python est moche, je sais, mais je le considère moins moche que de spécifier des chemins absolus.