realpython / realpython/python-guide

Clarification on pipenv and virtualenv

Ouverte
#981 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Batchfile
Étoiles
29.8k
Forks
5.9k
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

In the Virtual Environments document (dev/virtualenvs/) we start off by learning about pipenv but then move on to the lower level virtualenv. It is a little unclear under what circumstances we would be using virtualenv? I mean, I know it can practically be used, but for folks approaching Python for the first time it can be confusing.

I'm not suggesting the virtualenv section should go away, but maybe some additional clarification would be helpful. Something along the lines of:

"pipenv wraps a lower-level virtual environment utility - virtualenv. If you want to learn about using virtualenv, read on. Otherwise you can skip to the next chapter."

Where I personally really started getting confused is under Other Notes. Without scrolling back up the page it is not clear if this section is a part of the virtualenv discussion or if it is meant to be top-level and thus applicable to both pipenv and virtualenv.

Things become murkier when we start throwing additional utilities into the mix - as someone without experience with these utilities it seems to me that together they run somewhat parallel to pipenv.

Thanks for your hard work on this guide!

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le document Virtual Environments dans dev/virtualenvs/ et lisez ensemble les sections pipenv, virtualenv et Other Notes. Clarifiez le lien entre pipenv et virtualenv, indiquez quand les lecteurs peuvent passer le contenu sur virtualenv et précisez quelles notes s’appliquent à chaque utilitaire ; le travail est terminé lorsqu’un lecteur découvrant Python peut suivre la section sans confusion.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.