pypa / pypa/packaging.python.org

Add topic guides based on Discourse Discussion

Aperta
#1,334 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

component: guides type: discussion
Lingua principale
Python
Stelle
1.7k
Fork
1.7k
Merge medio
3g 12h
PR unite (30g)
4

Descrizione

https://discuss.python.org/t/user-experience-with-porting-off-setup-py/37502/77#topic-guides-1

Topic Guides

  • Packaging a pure-Python project with basic defaults
    Walk through the simplest possible case. Given some of the more important definitions. This needs to mention that backends, etc exists, and link to other guides. It is important to convey to beginners that if they hit a wall with simplest things, that there is more to look into, and some idea where.

  • Using and choosing build backends
    Has many definitions: what is a backend, why does it matter? Discussions and comparisons of common/popular backends and their configuration, at least one full example, and lots of links to backend projects docs.

  • Handling advanced cases with compilation steps
    A couple of full examples, discussion and links of tools like scikit-build or advanced build capabilities of other backends. There’s lots to potentially cover here, or at least mention and link to things about: cython, wrapping C, C++ or Fortran, building/bundling Typescript. Maybe suggest DPO as a place for deep technical questions.

  • Publishing packages
    Information about PyPI and twine.

  • Modernizing legacy setup.py usage
    Address all the things that came up for the OP here, links to the other guides as appropriate. Quick tips/FAQs for common things e.g. “what do I do with these command line arguments?”

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 dalla discussione Discourse collegata e dall'elenco delle guide non selezionate in questa issue. Definisci l'ambito e la struttura delle guide che riguardano il packaging di base in pure-Python, i backend di build, i casi di compilazione e la pubblicazione con PyPI e twine. Il lavoro è completato quando ogni guida non selezionata include spiegazioni orientate ai principianti, esempi pertinenti e collegamenti a documentazione più approfondita; la guida legacy su setup.py è già contrassegnata come completata.

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.