Installation - elastic/dorothy GitHub Wiki

You can install the latest release of Dorothy from PyPI. Alternatively, to use the latest features, you can clone the GitHub repo and run Dorothy as a Python module.

Although not required, consider installing Dorothy in a virtual environment to avoid dependency conflicts with other software.

• Installing from PyPI
• Installing from GitHub

Installing from PyPI

# Create and activate the virtual environment
$ python3.8 -m virtualenv .venv
$ source .venv/bin/activate

# Install the package from PyPI
(.venv) $ pip install dorothy
Collecting dorothy
  Downloading dorothy-0.2.1-py3-none-any.whl (77 kB)
     |████████████████████████████████| 77 kB 1.9 MB/s
Requirement already satisfied: setuptools~=50.3.2 in ./.venv/lib/python3.8/site-packages (from dorothy) (50.3.2)
Collecting click-shell~=2.0
.....
Installing collected packages: click, click-shell, certifi, chardet, urllib3, idna, requests, PyYAML, elasticsearch, tabulate, dorothy
Successfully installed PyYAML-5.3.1 certifi-2020.12.5 chardet-3.0.4 click-7.1.2 click-shell-2.0 dorothy-0.2.1 elasticsearch-7.10.0 idna-2.10 requests-2.24.0 tabulate-0.8.7 urllib3-1.25.11

# Start Dorothy
(.venv) $ dorothy

Installing from GitHub

# Clone the repo
$ git clone https://github.com/elastic/dorothy.git
$ cd dorothy

# Create and activate the virtual environment
$ python3.8 -m virtualenv .venv
$ source .venv/bin/activate

# Install Dorothy's dependencies
(.venv) $ pip install -r requirements.txt

# Start Dorothy
(.venv) $ python -m dorothy