pypa / pypa/packaging.python.org

Clarify that Packaging Tutorial is for importable modules

Aperta
#614 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
1.7k
Fork
1.7k
Merge medio
3g 12h
PR unite (30g)
4

Descrizione

Following-up from a discussion with @ncoghlan at the PyCon 2019 packaging sprint, re: https://packaging.python.org/tutorials/packaging-projects/

I have a simple executable script that I run on the command line as python my_utility.py. I'd rather run it as my_utility. The tutorial doesn't cover entry_points. I don't necessarily think it should, but I think it'd be helpful to make that a clear distinction, possibly with links to relevant next steps.

entry_points is discussed in the packaging and distributing guide, and used in the sample project.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con il Packaging Tutorial all’indirizzo https://packaging.python.org/tutorials/packaging-projects/ e confrontane l’ambito con la guida collegata sugli entry points e il progetto di esempio. Chiarisci che il tutorial è rivolto ai moduli importabili, quindi aggiungi link o indicazioni sui passaggi successivi per gli script eseguibili; il tutorial dovrebbe rendere esplicita questa distinzione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.