From f7be2639fa2052d4800bed8d12554fbb41ef181a Mon Sep 17 00:00:00 2001 From: Corey Goldberg Date: Tue, 31 Jul 2018 09:50:37 -0400 Subject: [PATCH 1/3] updated installation instructions in docs --- docs/installation.rst | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 320adf4ee3..e29a50537f 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,14 +1,28 @@ Installation ============ -Locust is available on PyPI and can be installed through pip or easy_install +Locust is available on [PyPI](https://pypi.org/project/locustio/) and can be installed with [pip](https://pip.pypa.io/). + +for Python 2.7: + +.. code-block:: console + + $ python -m pip install locustio + +for Python 3: .. code-block:: console - pip install locustio + $ python3 -m pip install locustio +If you want the bleeding edge version, you can use pip to install directly from our Git repository. For example, to install the master branch using Python 3: -When Locust is installed, a **locust** command should be available in your shell (if you're not using +.. code-block:: console + + $ python3 -m pip install -e git://github.com/locustio/locust.git@master#egg=locustio + + +Once Locust is installed, a **locust** command should be available in your shell. (if you're not using virtualenv—which you should—make sure your python script directory is on your path). To see available options, run: @@ -27,12 +41,12 @@ Locust supports Python 2.7, 3.4, 3.5, and 3.6. Installing Locust on Windows ---------------------------- -On Windows, running ``pip install locustio`` *should* work. +On Windows, running ``pip install locustio`` *should* work. However, if it doesn't, chances are that it can be fixed by first installing -the pre built binary packages for pyzmq, gevent and greenlet. +the pre built binary packages for pyzmq, gevent and greenlet. -You can find an unofficial collection of pre built python packages for windows here: +You can find an unofficial collection of pre built python packages for windows here: `http://www.lfd.uci.edu/~gohlke/pythonlibs/ `_ When you've downloaded a pre-built ``.whl`` file, you can install it with: @@ -41,26 +55,26 @@ When you've downloaded a pre-built ``.whl`` file, you can install it with: $ pip install name-of-file.whl -Once you've done that you should be able to just ``pip install locustio``. +Once you've done that you should be able to just ``pip install locustio``. .. note:: - Running Locust on Windows should work fine for developing and testing your load testing - scripts. However, when running large scale tests, it's recommended that you do that on + Running Locust on Windows should work fine for developing and testing your load testing + scripts. However, when running large scale tests, it's recommended that you do that on Linux machines, since gevent's performance under Windows is poor. -Installing Locust on OS X -------------------------- +Installing Locust on macOS +-------------------------- The following is currently the shortest path to installing gevent on OS X using Homebrew. #. Install `Homebrew `_. #. Install libev (dependency for gevent): - .. code-block:: console +.. code-block:: console - brew install libev + brew install libev #. Then follow the above instructions. From a44de24bf201595f2fe642cf844c5dabcc18c696 Mon Sep 17 00:00:00 2001 From: Corey Goldberg Date: Tue, 31 Jul 2018 10:00:55 -0400 Subject: [PATCH 2/3] fix doc links --- docs/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index e29a50537f..ca3fd8bb88 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,7 +1,7 @@ Installation ============ -Locust is available on [PyPI](https://pypi.org/project/locustio/) and can be installed with [pip](https://pip.pypa.io/). +Locust is available on `PyPI `_ and can be installed with `pip `_. for Python 2.7: From 55cae6a8b8f55e0a748acc50a7adcb360f24033f Mon Sep 17 00:00:00 2001 From: Corey Goldberg Date: Tue, 31 Jul 2018 10:02:50 -0400 Subject: [PATCH 3/3] fix newline --- docs/installation.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index ca3fd8bb88..1a99a217f0 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -21,7 +21,6 @@ If you want the bleeding edge version, you can use pip to install directly from $ python3 -m pip install -e git://github.com/locustio/locust.git@master#egg=locustio - Once Locust is installed, a **locust** command should be available in your shell. (if you're not using virtualenv—which you should—make sure your python script directory is on your path).