Skip to content

Commit

Permalink
docs: Promote pipx to install Meltano (meltano#7639)
Browse files Browse the repository at this point in the history
Co-authored-by: Taylor A. Murphy <taylor@meltano.com>
Co-authored-by: Edgar R. M. <edgar@meltano.com>
  • Loading branch information
3 people committed May 3, 2023
1 parent 9b7cef7 commit e8fb454
Showing 1 changed file with 27 additions and 24 deletions.
51 changes: 27 additions & 24 deletions docs/src/_getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,30 @@ Before you can use Meltano, you’ll need to get it installed. We have a [comple

## Install Meltano

Use the following command to check that you have a supported Python version installed:

```bash
python --version
```

{% tabs log %}
Meltano supports all versions of Python that have not yet reached their end-of-life date. Refer to [the official Python documentation for when versions of Python will reach end-of-life](https://devguide.python.org/versions/).

<div class="notification is-warning">
<p>Not all plugins support the latest versions of Python.</p>
</div>

{% tab log Using Pip %}
{% tabs log %}

Meltano is pip-installable.
{% tab log Using pipx %}

Use the following command to check that you have a supported Python version installed:
Since Meltano is an application, it should always be installed into a clean virtual environment without any other packages installed alongside it.

```bash
python --version
```
Currently Python 3.7, 3.8, 3.9, 3.10 and 3.11 are supported. Some plugins do not yet support Python 3.11.
To simplify installing Meltano into a clean virtual environment, [`pipx`](https://pypa.github.io/pipx/) can be used to install Meltano instead of `pip`. `pip` is a package installer that comes automatically with Python. `pipx` is a wrapper around pip which cleanly installs executable Python applications (such as Meltano) into their own virtual environments.

<div class="termy">

```console
$ pip install --upgrade pip
Requirement already satisfied.
$ pip install "meltano"
$ pipx install "meltano"
---> 100%
successfully installed meltano
```
Expand All @@ -40,9 +43,10 @@ successfully installed meltano
{% endtab %}

{% tab log Using Docker %}
We maintain the `meltano/meltano` Docker image on Docker Hub, which comes with Python and Meltano pre-installed.

To get the latest version of Meltano, pull the latest tag. Images for specific versions of Meltano are tagged v<X.Y.Z>, e.g. v1.55.0. Add a `-python<X.Y>` suffix to the image tag to change the python version, e.g. latest-python3.7.
We maintain [the `meltano/meltano` Docker image on Docker Hub](https://hub.docker.com/r/meltano/meltano/tags), which comes with Python and Meltano pre-installed.

To get the latest version of Meltano, pull the latest tag. Images for specific versions of Meltano are tagged `v<major>.<minor>.<patch>`, e.g. `v2.19.0`. Add a `-python3.X` suffix to the image tag to change the python version, e.g. `latest-python3.9`. To get the latest minor or patch version, omit that value from the version number, e.g. `v2` for the latest Meltano `v2.*.*` image, or `v2.19` for the latest Meltano `v2.19.*` image

<div class="termy">
```console
Expand All @@ -53,34 +57,33 @@ Status: Downloaded newer image for meltano/meltano:latest
docker.io/meltano/meltano:latest

$ docker run meltano/meltano --version
meltano, version 2.7.1
meltano, version 2.19.0
```

</div>

{% endtab %}

{% tab log Using PIPX %}
Meltano is pip-installable.
{% tab log Using pip %}

Use the following command to check that you have a supported Python version installed:

```bash
python --version
```
Currently Python 3.7, 3.8, 3.9, 3.10 and 3.11 are supported. Some plugins do not yet support Python 3.11.
Meltano provides a Python package that can be installed using `pip`.

Pip is a package installer that comes automatically with Python 3+. [pipx](https://pypa.github.io/pipx/) is a wrapper around pip which cleanly installs executable python tools (such as Meltano) into their own virtual environments.
<div class="notification is-warning">
<p>To avoid dependency conflicts, please ensure Meltano is installed into a clean Python virtual environment.</p>
</div>

<div class="termy">

```console
$ pipx install "meltano"
$ pip install --upgrade pip
Requirement already satisfied.
$ pip install "meltano"
---> 100%
successfully installed meltano
```

</div>

{% endtab %}

{% endtabs %}
Expand Down

0 comments on commit e8fb454

Please sign in to comment.