Skip to content

Commit 5679af3

Browse files
authored
Fix installation docs after PR#1151 (#1185)
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
1 parent b8592a6 commit 5679af3

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

docs/install.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ We recommend to use `pyenv <https://github.com/pyenv/pyenv>`_ to manage installa
2727
Once ``pyenv`` is installed, install a compatible Python version::
2828

2929
# Install Python
30-
pyenv install 3.8.0
30+
pyenv install 3.8.7
3131

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

3636
# Upgrade pip
3737
python3 -m pip install --user --upgrade pip
@@ -113,16 +113,20 @@ Installing Rally
113113
----------------
114114

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

118119
VirtualEnv Install
119120
------------------
120121

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

123-
1. Set up a new virtualenv environment in a directory with ``python3 -m venv .``
124-
2. Activate the environment with ``source /path/to/virtualenv/dir/bin/activate``
125-
3. Install Rally with ``python3 -m pip install esrally``
124+
1. Set up a new virtualenv environment in a directory with ``python3 -m venv .venv``
125+
2. Activate the environment with ``source /path/to/virtualenv/.venv/bin/activate``
126+
3. Ensure pip is the latest version: ``python3 -m pip install --upgrade pip``
127+
.. important::
128+
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``.
129+
4. Install Rally with ``python3 -m pip install esrally``
126130

127131
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.
128132

0 commit comments

Comments
 (0)