pypa / pypa/packaging.python.org

Suggestion: Have a "Quick Start" guide

Aperta
#688 2 commenti 2 reazioni 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

I think it would be great if in addition to the in depth tutorial, there is actually a quick start guide.

To elaborate, if a brand new user of Python lands on https://pypi.org/, they see a link that says "learn about installing packages" that takes them to the tutorial. The tutorial is very lengthly, explains about the requirements, about venvs, about installing from requirements file and so on.

All of these are fine and useful for someone who comes to the page to really learn about how the installer works.

Consider scenario of a newcomer to Python, who isn't really in it to learn how pip works. Perhaps they were told by coworker or someone, "just use django/numpy/pillow/etc. All you need is Python and then pip install it". In this situation, their main goal is start using the third party libraries. So what happens then? They did exactly that: download Python from python.org, (3.8 because its new), and immediately typed pip install ... (that's what they were told). Did not have time to learn about pip/venv/ whatsover. But as you can predict, it doesn't work. For example, in MacOS, pip install ... likely installs it to their Python 2.

When people come to me with this problem, the easy answer I gave them usually is simply "you need to do python3.8 -m pip install .. and preferably in virtual environment". That's usually enough answer for them, they're not looking to learn about pip/virtualenv/packaging. They just want to start using the third party library.

The above scenario happens quite often, and I've been thinking a lot on how to improve the experience for people in these scenarios.

Some questions I asked myself:

  • should Python installer be improved? Should it teach people about pip/venv, etc? At the moment, the Mac installer provides a link to PyPI, which links to the tutorial.

  • should Python.org download page be improved? Should it be more explicit and say "you may need pip/virtual environment in order to install additional packages." At the moment, all we have is a link at the very bottom (way past all other info like, license, gpg key, release schedule etc), and all it says "looking for 3rd party modules? go to PyPI!". It is not clear to a new comer that this is where they need to go if they are going to install anything with pip.

  • when we land on pypi.org, pip is not mentioned anywhere. How would a newcomer, who was told to pip install X knows that they should be going to the tutorial page?

Since pypi.org is the place we point people to (from Python installer and from python.org downloads page), I wonder then, perhaps, a small step to improve this experience is if there is a quick "Howto". For example, a quick blurb that says: "to install a package do: python -m pip install X. Go to tutorial to learn more!"

So that's the background on why I'm suggesting this improvement. Thanks for considering, and let me know if I can help clarify anything, and sorry for rambling a bit.

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

Esamina il tutorial collegato sull'installazione dei pacchetti e i link attuali di pypi.org e della pagina dei download di Python. Definisci dove dovrebbe comparire una guida introduttiva rapida e quali indicazioni sull'installazione rivolte ai nuovi utenti dovrebbe contenere; il lavoro è completato quando il percorso proposto porta chiaramente i principianti a un comando funzionante per installare un pacchetto e al tutorial completo.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
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.