docs: add intruction to create virtualenv #1553
Conversation
content/docs/start/data-pipelines.md
Outdated
| @@ -38,6 +38,8 @@ Now let's install the requirements: | |||
| > first. | |||
|
|
|||
| ```dvc | |||
| $ python3 -m venv .env | |||
There was a problem hiding this comment.
this is great, didn't know that it's part of the standard library ... have been using virtualenv -p python3 .env so far
There was a problem hiding this comment.
Haha yeah it's awesome! venv is recommended since Python 3.6: 28.3. venv — Creation of virtual environments
content/docs/start/data-pipelines.md
Outdated
| > first. | ||
|
|
||
| ```dvc | ||
| $ python3 -m venv .env | ||
| $ source .env/bin/activate | ||
| $ pip install -r src/requirements.txt | ||
| ``` |
There was a problem hiding this comment.
If this stays, it should be part of the md block quote above, please.
But should it stay? I'm not sure. We purposefully don't include this in our docs any more (we try to avoid having to maintain docs/examples of non-DVC tools). We assume people will know some basics. THAT SAID, maybe in this case it's a good idea to keep it, as this is the most introductory of our docs.
There was a problem hiding this comment.
Also,
source .env/bin/activate
On Windows it's
.env/Scripts/activate
I know 😠 but that's another possible reason to avoid this.
There was a problem hiding this comment.
Hmm, got it. One cool thing spaCy has is this quick section to generate the command. But it makes more sense there because it's the first page of the Get Started guide. Here the page in question is the "third one" of the guide, I don't know if the pages should follow a sequence or not.
About assuming people will know some basics, maybe it would be good to add here a little more about what you guys assume about the audience of the docs?
There was a problem hiding this comment.
@dmesquita I've seen a few projects do a widget likes this for the installation page ... we can do something similar for the dvc.org/doc/install - that would be great. Please, feel free to create a ticket.
|
thanks @dmesquita ! |
| > [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) | ||
| > [virtual environment](https://python.readthedocs.io/en/stable/library/venv.html) |
There was a problem hiding this comment.
Thanks! We should probably change this link in other places as well. I think it's in a few places.
|
One downside of using built in venv is that
more on this here - https://chriswarrick.com/blog/2018/09/04/python-virtual-environments/ . |
|
Are you saying the change to use the |
|
@jorgeorpinel @dmesquita let you decide on this :) (ping the team as well - what do they think). |
Hello!
[edited]
This pull request changes the virtual virtual environment link from python tutorials to python docs.
The tutorials page has some text before getting to the command itself, the docs page is more straightforward so the user can paste the code get back to DVC guides :)