Azure-docs: Use `.venv` as the virtual environment name

Created on 24 Jun 2019  Â·  3Comments  Â·  Source: MicrosoftDocs/azure-docs

[if this is accepted then other pages will need updating as well]

Guidance from the Python community is to name virtual environments .venv. This prevents clashing with .env environment variable definition files (as supported by the Python extension for VS Code). It's also what various tools like pipenv automatically name virtual environment created in one's code directory.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

azure-functionsvc cxp doc-enhancement triaged

Most helpful comment

https://code.visualstudio.com/docs/python/environments#_environment-variable-definitions-file
https://pipenv.readthedocs.io/en/latest/advanced/#pipenv.environments.PIPENV_VENV_IN_PROJECT

Otherwise I'm the dev manager for the Python extension for VS Code and a founding member of the Python steering council and a core developer for 16 years if that helps. 😉 (I've also opened an issue against myself at https://bugs.python.org/issue37403 to officially document this as the recommendation.)

All 3 comments

Hi @brettcannon Thank you for your feedback!

Could you reference such guidance from Python community and perhaps an official documentation discussing it so? We might stick with the .env as this documentation is more of a Quickstart in nature but might add a note pointing out the common Python convention as well.

https://code.visualstudio.com/docs/python/environments#_environment-variable-definitions-file
https://pipenv.readthedocs.io/en/latest/advanced/#pipenv.environments.PIPENV_VENV_IN_PROJECT

Otherwise I'm the dev manager for the Python extension for VS Code and a founding member of the Python steering council and a core developer for 16 years if that helps. 😉 (I've also opened an issue against myself at https://bugs.python.org/issue37403 to officially document this as the recommendation.)

Thanks for that info, @brettcannon! I've created a PR that addresses this issue per your feedback. Once the PR is approved & merged, this issue will auto-close and the changes should reflect within the next 24hrs.

Also, this update was specific to this documentation only for now. @ggailey777 could you advise on other docs that may need the same treatment? Happy to create the PRs as needed :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

spottedmahn picture spottedmahn  Â·  3Comments

behnam89 picture behnam89  Â·  3Comments

mrdfuse picture mrdfuse  Â·  3Comments

ianpowell2017 picture ianpowell2017  Â·  3Comments

Agazoth picture Agazoth  Â·  3Comments