pypa / pypa/packaging.python.org
Canonical guide to specifying dependencies?
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 1.7k
- Merge medio
- 3g 12h
- PR unite (30g)
- 4
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo il tutorial esistente sulla gestione delle dipendenze delle applicazioni e PEP 508, quindi esamina la documentazione attuale su packaging.python.org per individuare le indicazioni sulle dipendenze. Un risultato completo fornirebbe una guida canonica che copra i sette argomenti elencati relativi alle dipendenze e vi collegherebbe il tutorial.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100