Clarification on pipenv and virtualenv
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the Virtual Environments document in dev/virtualenvs/ and read the pipenv, virtualenv, and Other Notes sections together. Clarify how pipenv relates to virtualenv, indicate when readers may skip the virtualenv material, and make clear which notes apply to each utility; done means a first-time Python reader can follow the section without confusion.
Written by the indexing model from the issue text.
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!
- Dominant language
- Batchfile
- Stars
- 29.8k
- Forks
- 5.9k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from realpython/python-guide
-
Page 404 error Open
Difficulty 1/5 Under an hour Newbie friendliness 65/100
realpython/python-guide#1104 · 2 comments ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 62/100
realpython/python-guide#327 ·
-
PyZMQ improvements Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
realpython/python-guide#326 · 5 comments ·
-
@alex Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
realpython/python-guide#1194 ·
-
Development Team SAP Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
realpython/python-guide#1192 ·
All issues in realpython/python-guide
Similar issues
-
triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
feature pydanty:is-working
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pydantic/pydantic-ai#8647 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100