pypa / pypa/packaging.python.org
Canonical guide to specifying dependencies?
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 1.7k
- Forks
- 1.7k
- Merge moyen
- 3 j 12 h
- PR mergées (30 j)
- 4
Description
We should probably have a canonical guide to installing dependencies on packaging.python.org, especially since PEP 508 has changed things like how to link to a git repository. I get a lot of questions like, "Why are my dependency links not working now?" and since I don't really use those I can just tell people, "Oh something about that changed, here's an inscrutable PEP that maybe would help"?
This could be done incrementally (and can be broken into smaller parts, providing there is "clearing house" page that links to the other pages), but it would be nice to clearly cover:
- The syntax for declaring dependencies
- The syntax for environment markers
- How to declare dependencies to a URL (i.e. not PyPI)
- The differences between what goes in a
requirements.txtfile and what can be declared ininstall_requires - The use of
constraints.txtfiles (which I think really reduces the need forrequirements.txt. - How to use extras.
- What is and is not allowed as a dependency in packages uploaded to PyPI.
Some of this is defined in various PEPs, but my understanding is that the canonical and current documentation should live on packaging.python.org.
There should also probably be a "hat note" (Wikipedia terminology) pointing to any such page from managing application dependencies to this page.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire le tutoriel existant sur la gestion des dépendances des applications et la PEP 508, puis auditez la documentation actuelle de packaging.python.org concernant les recommandations relatives aux dépendances. Un résultat complet fournirait un guide de référence couvrant les sept sujets liés aux dépendances énumérés et y ferait référence depuis le tutoriel.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100