python_modules/dagster/docs/sections/install/install.rst
Quick Start
To install dagster and dagit, run:
.. code-block:: console
$ pip install dagster dagit
This will install the latest stable version of dagster's packages in your current Python
environment.
Detailed Installation Guide
Dagster is tested on Python 3.7.3, 3.6.8, 3.5.7, and 2.7.16. Python 3 is strongly encouraged -- if you can, you won't regret making the switch!
To check that Python and the pip package manager are already installed, you can run:
.. code-block:: console
$ python --version
$ pip --version
If you're running Python 3.3 or later, you already have the venv package for managing virtualenvs. On Python 2.7, you can check whether you have the virtualenv tool installed by running:
.. code-block:: console
$ virtualenv --version
If these tools aren't present on your system, you can install them as follows:
Ubuntu
.. code-block:: console
$ sudo apt update
$ sudo apt install python3-dev python3-pip
macOS
Using Homebrew <https://brew.sh/>_:
.. code-block:: console
$ brew update
$ brew install python # Python 3
On Python 2.7, you can install virtualenv with:
.. code-block:: console
$ sudo pip install -U virtualenv # system-wide install
Windows (Python 3)
Install the Microsoft Visual C++ 2015 Redistributable Update 3. This comes with Visual Studio 2015 but can be installed separately as follows:
Install the 64-bit Python 3 release for Windows (select pip as an optional feature).
To use the dagit tool, you will also need to
install yarn <https://yarnpkg.com/lang/en/docs/install/>_.
Notes on Python virtualenvs
We strongly recommend installing dagster inside a Python virtualenv. If you are running Anaconda, you should install dagster inside a Conda environment.
To create a virtual environment on Python 3, you can just run:
.. code-block:: console
$ python3 -m venv ~/.venvs/dagster
This will create a new Python environment whose interpreter and libraries are isolated from those installed in other virtual environments, and (by default) any libraries installed in a “system” Python installed as part of your operating system.
On Python 2, you can use a tool like
virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/en/latest/>_
to manage your virtual environments, or just run:
.. code-block:: console
$ virtualenv ~/.venvs/dagster
You'll then need to 'activate' the virtualenvironment, in bash by running:
.. code-block:: console
$ source ~/.venvs/dagster/bin/activate
(For other shells, see the
venv documentation <https://docs.python.org/3/library/venv.html#creating-virtual-environments>_.)
If you are using Anaconda, you can run:
.. code-block:: console
$ conda create --name dagster
And then, on macOS or Ubuntu:
.. code-block:: console
$ source activate dagster
Or, on Windows:
.. code-block:: console
$ activate dagster