Come faccio a setup.pyincludere un file che non fa parte del codice? (In particolare, è un file di licenza, ma potrebbe essere qualsiasi altra cosa.)

Voglio essere in grado di controllare la posizione del file. Nella cartella di origine originale, il file si trova nella radice del pacchetto. (ovvero allo stesso livello del più alto __init__.py.) Voglio che rimanga esattamente lì quando il pacchetto è installato, indipendentemente dal sistema operativo. Come lo faccio?

Probabilmente il modo migliore per farlo è usare la setuptools package_datadirettiva. Questo significa usare setuptools(o distribute) invece di distutils, ma questo è un "upgrade" molto semplice.

Ecco un esempio completo (ma non testato):

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

Nota le linee specifiche che sono fondamentali qui:

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

package_dataè un nome dictdi pacchetto (vuoto = tutti i pacchetti) in un elenco di modelli (può includere globs). Ad esempio, se si desidera specificare solo i file all'interno del pacchetto, è possibile farlo anche:

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

La soluzione qui è sicuramente non per rinominare i non- pyfile con .pyestensione.

Vedi la presentazione di Ian Bicking per maggiori informazioni.

AGGIORNAMENTO: un altro approccio [migliore]

Un altro approccio che funziona bene se si desidera solo controllare il contenuto della distribuzione di origine ( sdist) e disporre di file all'esterno del pacchetto (ad esempio directory di livello superiore) è quello di aggiungere un MANIFEST.infile. Consulta la documentazione di Python per il formato di questo file.

Da quando ho scritto questa risposta, ho scoperto che l'utilizzo MANIFEST.inè in genere un approccio meno frustrante per assicurarsi che la distribuzione di origine ( tar.gz) abbia i file necessari.

Ad esempio, se si desidera includere il requirements.txtlivello principale, includere ricorsivamente la directory "dati" di livello superiore:

include requirements.txt
recursive-include data *

Tuttavia, per poter copiare questi file al momento dell'installazione nella cartella del pacchetto all'interno dei pacchetti del sito, sarà necessario fornire include_package_data=Truealla setup()funzione. Vedere Aggiunta di file non di codice per ulteriori informazioni.

Per realizzare ciò che stai descrivendo ci vorranno due passaggi ...

• Il file deve essere aggiunto al tarball di origine
• setup.py deve essere modificato per installare il file di dati nel percorso di origine

Passaggio 1: per aggiungere il file al tarball di origine, includerlo nel MANIFEST

Creare un modello MANIFEST nella cartella che contiene setup.py

MANIFEST è fondamentalmente un file di testo con un elenco di tutti i file che verranno inclusi nel tarball di origine.

Ecco come si presenta MANIFEST per il mio progetto:

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

Nota: Mentre sdist fa aggiungere automaticamente alcuni file , preferisco specificare esplicitamente loro di essere sicuri, invece di prevedere ciò che fa e non lo fa.

Passaggio 2: per installare il file di dati nella cartella di origine, modificare setup.py

Poiché stai cercando di aggiungere un file di dati (LICENSE.txt) alla cartella di installazione di origine, devi modificare il percorso di installazione dei dati in modo che corrisponda al percorso di installazione di origine. Ciò è necessario perché, per impostazione predefinita, i file di dati sono installati in una posizione diversa rispetto ai file di origine.

Per modificare la directory di installazione dei dati in modo che corrisponda alla directory di installazione di origine ...

Estrai le informazioni dir installazione da distutils con:

from distutils.command.install import INSTALL_SCHEMES

Modifica la directory di installazione dei dati in modo che corrisponda alla directory di installazione di origine:

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

E aggiungi il file di dati e il percorso a setup ():

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

Nota: i passaggi precedenti dovrebbero realizzare esattamente ciò che è stato descritto in modo standard senza richiedere librerie di estensioni.

creare MANIFEST.innella radice del progetto con recursive-includela directory richiesta o includecon il nome del file.

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

la documentazione è disponibile qui

Volevo pubblicare un commento a una delle domande ma non ho abbastanza reputazione per farlo>.>

Ecco cosa ha funzionato per me (ne è uscito dopo aver fatto riferimento ai documenti):

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

include_package_data: False

L'ultima riga è stata, stranamente, anche cruciale per me (puoi anche omettere questo argomento della parola chiave - funziona allo stesso modo).

Ciò consente di copiare tutti i file di testo nella directory principale o principale (a un livello superiore dal pacchetto che mypkgsi desidera distribuire).

Spero che questo ti aiuti!

Passaggio 1: crea un MANIFEST.infile nella stessa cartella con setup.py

Passaggio 2: includere il percorso relativo ai file che si desidera aggiungereMANIFEST.in

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

Passaggio 3: impostare include_package_data=Truela setup()funzione per copiare questi file nel pacchetto del sito

Il riferimento è qui.

È il 2019, ed ecco cosa funziona - nonostante i consigli qua e là, quello che ho trovato su Internet a metà documentato sta usando setuptools_scm, passato come opzioni a setuptools.setup. Ciò includerà tutti i file di dati che sono stati sottoposti a versioning sul VCS, sia esso git o qualsiasi altro, nel pacchetto wheel, e farà "installare pip" dal repository git per portare quei file.

Quindi, ho appena aggiunto queste due linee alla chiamata di installazione su "setup.py". Nessuna installazione aggiuntiva o richiesta di importazione:

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

Non è necessario elencare manualmente package_data o in un file MANIFEST.in - se è aggiornato, è incluso nel pacchetto. I documenti su "setuptools_scm" mettono l'accento sulla creazione di un numero di versione dalla posizione di commit e ignorano la parte veramente importante dell'aggiunta dei file di dati. (Non me ne può fregare di meno se il mio file della ruota intermedia si chiama "* 0.2.2.dev45 + g3495a1f" o utilizzerò il numero di versione hardcod "0.3.0dev0" che ho digitato - ma lasciando i file cruciali per il programma lavorare dietro è piuttosto importante)

In setup.py sotto setup (:

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

Ecco una risposta più semplice che ha funzionato per me.

Innanzitutto, per un commento di Python Dev sopra, setuptools non è richiesto:

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

È fantastico perché mettere un requisito setuptools sul tuo pacchetto significa che dovrai installarlo anche. In breve:

from distutils.core import setup

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

Volevo solo dare seguito a qualcosa che ho trovato lavorando con Python 2.7 su Centos 6. L'aggiunta di package_data o data_files come menzionato sopra non ha funzionato per me. Ho aggiunto un MANIFEST.IN con i file desiderati che hanno inserito i file non Python nel tarball, ma non li ho installati sul computer di destinazione tramite RPM.

Alla fine, sono stato in grado di ottenere i file nella mia soluzione usando le "opzioni" nei setup / setuptools. I file delle opzioni consentono di modificare varie sezioni del file delle specifiche da setup.py. Come segue.

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

file - MANIFEST.in:

include license.txt

file - file con i comandi di installazione:

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

Capito una soluzione: ho rinominato la mia lgpl2.1_license.txta lgpl2.1_license.txt.py, e mettere un po triple virgolette intorno al testo. Ora non ho bisogno di usare l' data_filesopzione né di specificare percorsi assoluti. Renderlo un modulo Python è brutto, lo so, ma lo considero meno brutto che specificare percorsi assoluti.