Référence requirements.txt pour le kwarg install_requires dans le fichier setuptools setup.py

Question

Tengo un requirements.txt que j'utilise avec Travis-CI. Il semble idiot de dupliquer les exigences dans les deux fichiers requirements.txt y setup.py J'espérais donc pouvoir passer une poignée de fichier à la fonction install_requires kwarg en setuptools.setup .

Est-ce possible ? Si oui, comment dois-je procéder ?

Voici mon requirements.txt fichier :

guessit>=0.5.2
tvdb_api>=1.8.2
hachoir-metadata>=1.3.3
hachoir-core>=1.3.3
hachoir-parser>=1.3.4

Answer 1

Vous pouvez inverser la situation et lister les dépendances dans la rubrique setup.py et ne comportent qu'un seul caractère - un point . - en requirements.txt au lieu de cela.

---

Par ailleurs, même si cela n'est pas conseillé, il est toujours possible d'analyser le fichier requirements.txt (s'il ne renvoie pas à des exigences externes par URL) avec le hack suivant (testé avec pip 9.0.1 ) :

install_reqs = parse_requirements('requirements.txt', session='hack')

Cela ne filtre pas marqueurs d'environnement mais

---

Dans les anciennes versions de pip, plus précisément plus ancien que 6.0 Il existe une API publique qui peut être utilisée à cette fin. Un fichier d'exigences peut contenir des commentaires ( # ) et peut inclure d'autres fichiers ( --requirement o -r ). Ainsi, si vous voulez vraiment analyser un fichier requirements.txt vous pouvez utiliser l'analyseur pip :

from pip.req import parse_requirements

# parse_requirements() returns generator of pip.req.InstallRequirement objects
install_reqs = parse_requirements(<requirements_path>)

# reqs is a list of requirement
# e.g. ['django==1.5.1', 'mezzanine==1.4.6']
reqs = [str(ir.req) for ir in install_reqs]

setup(
    ...
    install_requires=reqs
)

Answer 2

Il ne peut pas prendre de poignée de fichier. Les install_requires L'argument peut ne peut être qu'une chaîne de caractères ou une liste de chaînes de caractères .

Vous pouvez, bien sûr, lire votre fichier dans le setup script et le passer comme une liste de chaînes à install_requires .

import os
from setuptools import setup

with open('requirements.txt') as f:
    required = f.read().splitlines()

setup(...
install_requires=required,
...)

Answer 3

Les fichiers d'exigences utilisent un format de pipeline étendu, qui n'est utile que si vous avez besoin de compléter vos fichiers d'exigences. setup.py avec des contraintes plus fortes, par exemple en spécifiant les urls exactes dont certaines dépendances doivent provenir, ou la sortie de pip freeze pour geler l'ensemble des paquets à des versions connues et fonctionnelles. Si vous n'avez pas besoin de ces contraintes supplémentaires, utilisez uniquement une option setup.py . Si vous sentez que vous avez vraiment besoin d'expédier une requirements.txt Quoi qu'il en soit, vous pouvez en faire une seule ligne :

.

Il sera valide et se référera exactement au contenu de la rubrique setup.py qui se trouve dans le même répertoire.

Answer 4

Bien qu'il ne s'agisse pas d'une réponse exacte à la question, je recommande l'article du blog de Donald Stufft à l'adresse suivante https://caremad.io/2013/07/setup-vs-requirement/ pour une bonne approche de ce problème. Je l'ai utilisé avec beaucoup de succès.

En bref, requirements.txt n'est pas un setup.py mais un complément de déploiement. Conserver une abstraction appropriée des dépendances des paquets dans le fichier setup.py . Ensemble requirements.txt ou plus pour récupérer des versions spécifiques de dépendances de paquets pour le développement, les tests ou la production.

Par exemple, avec les paquets inclus dans le répertoire sous deps/ :

# fetch specific dependencies
--no-index
--find-links deps/

# install package
# NOTE: -e . for editable mode
.

pip exécute la commande setup.py et installe les versions spécifiques des dépendances déclarées dans le fichier install_requires . Il n'y a pas de double emploi et l'objectif des deux artefacts est préservé.

Answer 5

L'utilisation parse_requirements est problématique car l'API pip n'est pas publiquement documentée et prise en charge. Dans pip 1.6, cette fonction est en fait déplacée, de sorte que les utilisations existantes de cette fonction sont susceptibles d'être interrompues.

Un moyen plus fiable d'éliminer les doublons entre les setup.py y requirements.txt est de spécifier vos dépendances dans setup.py puis mettre -e . dans votre requirements.txt fichier. Certaines informations provenant de l'un des pip Les développeurs qui expliquent pourquoi il s'agit d'une meilleure solution sont disponibles ici : https://caremad.io/blog/setup-vs-requirement/