From a710443d80a546909f72e4ee8ecebb0c1996454f Mon Sep 17 00:00:00 2001 From: Derek Visch Date: Fri, 17 Jun 2022 14:07:42 -0400 Subject: [PATCH] Fixed broken links, and a few grammar improvements --- .../_concepts/python_virtual_environments.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/src/_concepts/python_virtual_environments.md b/docs/src/_concepts/python_virtual_environments.md index 87f23568d3..cb93fa2eae 100644 --- a/docs/src/_concepts/python_virtual_environments.md +++ b/docs/src/_concepts/python_virtual_environments.md @@ -8,8 +8,9 @@ weight: 12 Python Virtual Environments, also known as a venv, are a way to allow a Python application access to specific versions of the libraries it needs to run properly. In the Singer ecosystem -you may need to install multiple Taps and Targets, which all have different dependencies. -If any of those dependecies wer in conflict with each other you would have a difficult development experience without Virtual Envrionments. +you may need to install multiple Taps and Targets, which all have different dependencies. + +If any of those dependecies are were in conflict with each other you would have a difficult development experience without Virtual Envrionments. Python has a great technical write up at [Virtual Environments and Packages](https://docs.python.org/3/tutorial/venv.html). @@ -21,7 +22,7 @@ We're going to focus on the Meltano use case for Virtual Environments which is u Ideally, you don't have to to worry about Virtual Environments while using Meltano, we recommend using pipx to install Meltano which manages the creation of venvs for you. -See our [Installation Guide](../_guide/installation.md) for more details. +See our [Installation Guide](/guide/installation) for more details. However, if you ever need to customize or build your own production pipeline (or do anything else) you may need to understand how to install Meltano in an isolated way so that you don't have a conflict with dependecies within your own Operating System @@ -29,19 +30,19 @@ or other Python applications running on the same machine. # How do I use Virtual Environments? -We strongly suggest you create a directory where you want your virtual environments to be saved (e.g. `.venv/`). +We strongly suggest you create a directory where you want your virtual environments to be saved (e.g. `.venv/meltano/`). This can be any directory in your environment, but we recommend saving it in your Meltano project to make it easier to keep track of. Then create a new virtual environment inside that directory: ```bash -python -m venv .venv/meltano +python -m venv .venv/meltano/ ``` This `python` command is calling the `venv` package and it is creating a virtual environment in `.venv/meltano/`. -And that's it! You've created a virtual environment. +And that's it! You've created a virtual environment. Feel free to explore the directory and compare it to your global python directory! You can navigate to the directory by running `cd .venv/meltano/`. @@ -78,16 +79,16 @@ pip install meltano

As a reminder, we do generally recommend using `pipx` for installing python packages. -Ensure you have `pipx` installed by reviewing the [Install pipx](/guide/installation#install-pipx) instructions.

+Ensure you have `pipx` installed by reviewing the Install pipx instructions.

# How does meltano use Virtual Environments internally? Whenever you run `meltano install`, Meltano creates a `.meltano/` directory in your project. This directory has a number of sub-directories (subject to change at any point, as this is an -internal directory). +internal directory). In `.meltano/` you may see an `extractors/` directory that was created (if you -have an extractor). +have an extractor). In that directory you'll see the name of a your tap and inside of that directory is a virtual environment!