Nicht-Python-Dateien mit setup.py einbinden

Wie mache ich setup.py enthält eine Datei, die nicht Teil des Codes? (Genauer gesagt, ist es eine Lizenz-Datei, aber könnte es sein eine andere Sache.)

Ich will die Kontrolle über den Speicherort der Datei. Im original Ordner, wird die Datei in das root-Paket. (d.h. auf der gleichen Ebene wie der oberste __init__.py.) Ich will es bleiben genau da, wenn das Paket installiert ist, unabhängig vom Betriebssystem. Wie mache ich das?

InformationsquelleAutor der Frage Ram Rachum | 2009-10-23

  1. 139

    Wahrscheinlich der beste Weg, dies zu tun, ist die Verwendung der setuptools package_data Richtlinie. Dies bedeutet, dass mit setuptools (oder verteilen) statt distutilsaber das ist eine sehr nahtlose "upgrade".

    Hier ist eine vollständige (aber nicht getestet) Beispiel:

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

    Beachten Sie, dass die Linien, die kritisch sind hier:

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

    package_data ist ein dict package-Namen (leer = alle Pakete), um eine Liste von mustern (globs). Zum Beispiel, wenn Sie wollen, geben Sie nur die Dateien in Ihr Paket, Sie können das auch tun:

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

    Die Lösung ist hier auf jeden Fall nicht umbenennen-nicht-py Dateien mit einem .py Erweiterung.

    Sehen Ian Bicking Präsentation für mehr info.

    UPDATE: ein Anderes [Besseres] Ansatz

    Anderen Ansatz, die gut funktioniert, wenn Sie nur wollen, um eine Kontrolle der Inhalte der source-distribution (sdist) und Dateien außerhalb des Pakets (z.B. top-level-Verzeichnis) ist das hinzufügen von ein MANIFEST.in - Datei. Sehen die Python-Dokumentation für das format dieser Datei.

    Da das schreiben dieser Antwort, habe ich festgestellt, dass mit MANIFEST.in ist in der Regel eine weniger frustrierend Ansatz, so stellen Sie sicher, dass Ihre Quell-distribution (tar.gz) hat die Dateien, die Sie benötigen.

    Zum Beispiel, wenn Sie wollte die requirements.txt von top-level-rekursiv-die top-level - "data" - Verzeichnis:

    include requirements.txt
recursive-include data *

    Dennoch, um für diese Dateien kopiert werden beim installieren Zeit, um das Paket den Ordner in Website-Pakete, die Sie benötigen, zu liefern include_package_data=True zu den setup() Funktion. Sehen Zugabe Von Nicht-Code-Dateien für weitere Informationen.

    InformationsquelleAutor der Antwort Hans L

  2. 40

    Zu erreichen, was Sie beschreiben wird, nehmen Sie zwei Schritte...

    • Die Datei Hinzugefügt werden muss, um den Quelltext-tarball herunter
    • setup.py muss geändert werden, installieren Sie die Daten-Datei auf der source-Pfad

    Schritt 1: fügen Sie die Datei dem Quell-tarball, es in dem MANIFEST

    Erstellen Sie eine MANIFEST Vorlage in dem Ordner, der enthält setup.py

    Das MANIFEST ist im wesentlichen eine Textdatei mit einer Liste aller Dateien, die aufgenommen werden, in den Quelltext-tarball herunter.

    Hier ist, was das MANIFEST für mein Projekt so Aussehen:

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

    Hinweis: Während sdist nicht fügen Sie einige Dateien automatischich bevorzuge, um explizit anzugeben, um sicher zu sein, anstatt zu prognostizieren, was es tut und nicht tut.

    Schritt 2: installieren Sie die Daten-Datei auf der source-Ordner ändern setup.py

    Da Sie schauen, um eine Daten-Datei (LICENSE.txt), um die Quelle Ordner installieren, müssen Sie die Daten ändern, installieren, Pfad in übereinstimmung mit der Quelle installieren Weg. Dies ist notwendig, da standardmäßig die Daten-Dateien installiert sind, an einen anderen Ort als die Quelldateien.

    Die Daten ändern, installieren, dir entsprechend die Quelle installieren dir...

    Ziehen, die installieren dir info von distutils mit:

    from distutils.command.install import INSTALL_SCHEMES

    Ändern Sie die Daten, die installieren dir entsprechend die source-install-dir:

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

    Und fügen Sie die Daten-Datei und den Speicherort zu setup():

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

    Hinweis: Die oben genannten Schritte erledigen sollte genau das, was Sie beschrieben haben, in einem standard-Weise, ohne dass irgendwelche Bibliotheken mit der Endung.

    InformationsquelleAutor der Antwort Evan Plaice

  3. 5

    In setup.py unter setup( :

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

    InformationsquelleAutor der Antwort Dashing Adam Hughes

  4. 3

    Hier ist eine einfachere Antwort, die für mich gearbeitet.

    Erste, je ein Python-Dev ' s Kommentar oben, setuptools ist nicht erforderlich:

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

    Das ist toll, weil die Umsetzung eine setuptools Anforderung auf der Verpackung bedeutet, dass Sie haben, um es zu installieren auch. Kurz gesagt:

    from distutils.core import setup

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

    InformationsquelleAutor der Antwort Gringo Suave

  5. 2

    erstellen MANIFEST.in im Projekt-root mit recursive-include auf das gewünschte Verzeichnis oder include mit der Datei name.

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

    die Dokumentation kann hier gefunden werden

    InformationsquelleAutor der Antwort All Іѕ Vаиітy

  6. 1

    Ich wollte nur follow-up auf etwas, das ich gefunden, die das arbeiten mit Python 2.7 auf Centos 6. Hinzufügen der package_data oder data_files wie oben erwähnt nicht für mich arbeiten. Ich fügte hinzu, ein MANIFEST.Mit den Dateien, die ich wollte welche die nicht-python-Dateien in das tar-Archiv, aber nicht installieren Sie Sie auf dem Zielcomputer über U /MIN.

    In das Ende, ich war in der Lage, um die Dateien in meine Lösung mit den "Optionen" im setup - /setuptools. Die option Dateien lassen ändern Sie Sie zu verschiedenen Abschnitten der spec-Datei aus setup.py. Wie folgt.

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

    Datei - MANIFEST.in:

    include license.txt

    Datei - 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

    InformationsquelleAutor der Antwort Scott Bowers

  7. -14

    Herausgefunden Problemumgehung: umbenannt habe ich meine lgpl2.1_license.txt zu lgpl2.1_license.txt.pyund legte einige dreifachen Anführungszeichen um den text. Nun, ich brauche nicht zu verwenden, die data_files option noch die Angabe von absoluten Pfaden. So dass es ein Python-Modul ist hässlich, ich weiß, aber ich halte es für weniger hässlich als die Angabe absoluter Pfade.

    InformationsquelleAutor der Antwort Ram Rachum

Schreibe einen Kommentar