In this section, we will install Meltano as an application you can access from your browser and command line. If you prefer to install to Docker, please view the installation instructions here.
We do not have a double click installer at this time, but it is in our roadmap and we will be sure to update this page when we do!
Before you install meltano with
pip install meltano make sure you have the following requirements installed and up to date.
You may refer to https://realpython.com/installing-python/ for platform specific installation instructions.
To check if you have the correct Python version, open your terminal and use the following commands to check the version:
pip is a package installer that comes automatically with Python 3+. This is also what we will be using to install Meltano. Here are some commands related to
pip that may be of interest:
# Check for current version of pip pip --version # Update pip pip install --upgrade pip
python is not working, try
python3 instead. This would be the case if you have both Python 2+ and 3+ installed.
Unless you are building a Docker image, It is strongly recommended that Meltano be installed inside a virtual environment in order to avoid potential system conflicts that may be difficult to debug.
Why use a virtual environment?
Your local environment may use a different version of Python or other dependencies that are difficult to manage. The virtual environment provides a "clean" space to work without these issues.
We suggest you create a directory where you want your virtual environments to be saved, e.g.:
Then create a new virtual environment inside that directory:
# Linux, OSX mkdir ~/virtualenvs python -m venv ~/virtualenvs/meltano # Windows mkdir %ALLUSERSPROFILE%\\virtualenvs python -m venv %ALLUSERSPROFILE%\\virtualenvs\\meltano
Activate the virtual environment using:
# Linux, OSX source ~/virtualenvs/meltano/bin/activate # Windows %HOME%\\virtualenvs\\meltano\\Scripts\\activate.bat
Now that you have your virtual environment set up and running, navigate to the directory where you want to install Meltano and run the following command:
pip install meltano
Once the installation completes, you can check if it was successful by running:
That's it! Meltano is now be available for you to use. Now we can create a Meltano project.
Once a virtual environment is activated, it stays active until the current shell is closed.
You must re-activate the virtual environment before interacting with Meltano.
To streamline this process, you can add the
meltano executable directly in your
# Linux, OSX export PATH=$PATH:$HOME/virtualenvs/meltano/bin/meltano # Windows setx PATH "%PATH%;%ALLUSERPROFILES\virtualenvs\meltano\Scripts\meltano"
Docker is an alternative installation option to using a virtual environment to run Meltano. To use these instructions you will need to install Docker onto your computer and have it running when you execute the commands below.
We provide the meltano/meltano docker image with Meltano pre-installed and ready to use.
Note: The meltano/meltano docker image is also available in GitLab's registry:
This image contains everything you need to get started with Meltano.
# download or update to the latest version docker pull meltano/meltano # look the currently installed version docker run meltano/meltano --version
Once you have Docker installed, running, and have pulled the pre-built image you can use Meltano just as you would in our Quickstart Guide. However, the command line syntax is slightly different. For example, let's create a new Meltano project:
docker run -v $(pwd):/projects \ -w /projects \ meltano/meltano init YOUR_PROJECT_NAME
Then you can
cd into your new project:
We can then start the Meltano UI. Since
ui is the default command, we can omit it.
docker run -v $(pwd):/project \ -w /project \ -p 5000:5000 \ meltano/meltano
You can now visit http://localhost:5000 to access the Meltano UI.
If you are a Meltano end-user who is not going to be contributing code to our open source repository, you should be able to use Meltano entirely from the UI at this point.
Follow the steps in our Quickstart Guide to get started.
Here are some example of CLI commands you may need to run if you are working with Meltano as an open source contributor:
To run the ELT and extract some data from the tap-carbon-intensity into target-sqlite:
docker run -v $(pwd):/project \ -w /project \ meltano/meltano elt tap-carbon-intensity target-sqlite
Now that we have data in your database, let's add the corresponding model bundle as the basis of our analysis.
docker run -v $(pwd):/project \ -w /project \ meltano/meltano add model model-carbon-intensity-sqlite
We release new versions of Meltano weekly. To update Meltano to the latest version, run the following command in your terminal:
pip install --upgrade meltano
This guide assumes that you have a functioning Docker image where your Meltano project is already bundled with the Meltano installation. To track this issue, follow meltano#624.
In this section, we will be going over how you can deploy a Meltano Docker image to AWS.
Configurebutton in the custom card
Updatebutton to finish setting up your container defintion
Editnext to the Task defintion heading
Nextto move to the next step
Nextto move on to the next step
The main configuration here is the Cluster name. We provide a suggestion below, but feel free to name it as you wish.
After you click
Next, you will have the opportunity to review all of the properties that you set. Once you confirm that the settings are correct, click
Create to setup your ECS.
You should now see a page where Amazon prepares the services we configured. There will be spinning icons on the right of each service that will live update as it finished. Once you see everything has setup properly, you're cluster has been successfully deployed!
RUNNINGfor Last Status
The IP address can be mapped to a domain using Route53. We will be writing up a guide on how to do this. You can follow along at meltano#625.
This section is only necessary if you do not have a Security Group that allows for port 5000,5010 inbound.
Once you complete the cluster setup, you should be brought to the detail page for the service. You should be default on a tab called Details with a Network Access section.
Add Rulewith the following properties:
Are you having installation or deployment problems? We are here to help you. Please fill out this issue template and we'll get back to you as soon as we can!