Merge pull request #857 from locustio/install-instructions

Install instructions

docs/installation.rst

@@ -1,14 +1,27 @@
 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 +40,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/ <http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_
 
 When you've downloaded a pre-built ``.whl`` file, you can install it with:
@@ -41,26 +54,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 <http://mxcl.github.com/homebrew/>`_.
 #. Install libev (dependency for gevent):
 
-    .. code-block:: console
+.. code-block:: console
 
-        brew install libev
+    brew install libev
 
 #. Then follow the above instructions.