Skip to content

Commit

Permalink
Fix installation docs after PR#1151 (#1185)
Browse files Browse the repository at this point in the history
With the `2020-resolver` requirement removed in #1151, installation in
virtualenv will fail due older pip versions not using the new
dependency resolver by default[1].

This commit updates the docs such that users always need to upgrade
`pip`, either in a local or `virtualenv` environments prior to esrally
installation.

[1] https://discuss.python.org/t/announcement-pip-20-3-release/5948

Relates #1184
  • Loading branch information
dliappis committed Feb 15, 2021
1 parent b8592a6 commit 5679af3
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ We recommend to use `pyenv <https://github.com/pyenv/pyenv>`_ to manage installa
Once ``pyenv`` is installed, install a compatible Python version::

# Install Python
pyenv install 3.8.0
pyenv install 3.8.7

# select that version for the current user
# see https://github.com/pyenv/pyenv/blob/master/COMMANDS.md#pyenv-global for details
pyenv global 3.8.0
pyenv global 3.8.7

# Upgrade pip
python3 -m pip install --user --upgrade pip
Expand Down Expand Up @@ -113,16 +113,20 @@ Installing Rally
----------------

1. Ensure ``~/.local/bin`` is in your ``$PATH``.
2. Install Rally: ``python3 -m pip install --user esrally``.
2. Ensure pip is the latest version: ``python3 -m pip install --user --upgrade pip``
3. Install Rally: ``python3 -m pip install --user esrally``.

VirtualEnv Install
------------------

You can also use Virtualenv to install Rally into an isolated Python environment without sudo.

1. Set up a new virtualenv environment in a directory with ``python3 -m venv .``
2. Activate the environment with ``source /path/to/virtualenv/dir/bin/activate``
3. Install Rally with ``python3 -m pip install esrally``
1. Set up a new virtualenv environment in a directory with ``python3 -m venv .venv``
2. Activate the environment with ``source /path/to/virtualenv/.venv/bin/activate``
3. Ensure pip is the latest version: ``python3 -m pip install --upgrade pip``
.. important::
Omitting this step might cause the next step (Rally installation) to fail due to broken dependencies. The pip version must be at minimum ``20.3``.
4. Install Rally with ``python3 -m pip install esrally``

Whenever you want to use Rally, run the activation script (step 2 above) first. When you are done, simply execute ``deactivate`` in the shell to exit the virtual environment.

Expand Down

0 comments on commit 5679af3

Please sign in to comment.