Skip to content

Commit

Permalink
Convert to Unix line endings
Browse files Browse the repository at this point in the history
  • Loading branch information
heyman committed Dec 2, 2013
1 parent 4ca0eef commit a58c469
Show file tree
Hide file tree
Showing 18 changed files with 2,295 additions and 2,295 deletions.
4 changes: 2 additions & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
recursive-include locust/static *
recursive-include locust/templates *
recursive-include locust/static *
recursive-include locust/templates *
156 changes: 78 additions & 78 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,78 +1,78 @@
###
API
###


Locust class
============

.. autoclass:: locust.core.Locust
:members: min_wait, max_wait, task_set

HttpLocust class
================

.. autoclass:: locust.core.HttpLocust
:members: min_wait, max_wait, task_set, client


TaskSet class
=============

.. autoclass:: locust.core.TaskSet
:members: locust, parent, min_wait, max_wait, client, tasks, interrupt, schedule_task

task decorator
==============

.. autofunction:: locust.core.task


HttpSession class
=================

.. autoclass:: locust.clients.HttpSession
:members: __init__, request, get, post, delete, put, head, options, patch

Response class
==============

This class actually resides in the `python-requests <http://python-requests.org>`_ library,
since that's what Locust is using to make HTTP requests, but it's included in the API docs
for locust since it's so central when writing locust load tests. You can also look at the
:py:class:`Response <requests.Response>` class at the
`requests documentation <http://python-requests.org>`_.

.. autoclass:: requests.Response
:inherited-members:
:noindex:

ResponseContextManager class
============================

.. autoclass:: locust.clients.ResponseContextManager
:members: success, failure


InterruptTaskSet Exception
==========================
.. autoexception:: locust.exception.InterruptTaskSet


.. _events:

Event hooks
===========

The event hooks are instances of the **locust.events.EventHook** class:

.. autoclass:: locust.events.EventHook

Available hooks
---------------

The following event hooks are available under the **locust.events** module:

.. automodule:: locust.events
:members: request_success, request_failure, locust_error, report_to_master, slave_report, hatch_complete, quitting

###
API
###


Locust class
============

.. autoclass:: locust.core.Locust
:members: min_wait, max_wait, task_set

HttpLocust class
================

.. autoclass:: locust.core.HttpLocust
:members: min_wait, max_wait, task_set, client


TaskSet class
=============

.. autoclass:: locust.core.TaskSet
:members: locust, parent, min_wait, max_wait, client, tasks, interrupt, schedule_task

task decorator
==============

.. autofunction:: locust.core.task


HttpSession class
=================

.. autoclass:: locust.clients.HttpSession
:members: __init__, request, get, post, delete, put, head, options, patch

Response class
==============

This class actually resides in the `python-requests <http://python-requests.org>`_ library,
since that's what Locust is using to make HTTP requests, but it's included in the API docs
for locust since it's so central when writing locust load tests. You can also look at the
:py:class:`Response <requests.Response>` class at the
`requests documentation <http://python-requests.org>`_.

.. autoclass:: requests.Response
:inherited-members:
:noindex:

ResponseContextManager class
============================

.. autoclass:: locust.clients.ResponseContextManager
:members: success, failure


InterruptTaskSet Exception
==========================
.. autoexception:: locust.exception.InterruptTaskSet


.. _events:

Event hooks
===========

The event hooks are instances of the **locust.events.EventHook** class:

.. autoclass:: locust.events.EventHook

Available hooks
---------------

The following event hooks are available under the **locust.events** module:

.. automodule:: locust.events
:members: request_success, request_failure, locust_error, report_to_master, slave_report, hatch_complete, quitting

52 changes: 26 additions & 26 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
=====================
Locust Documentation
=====================

.. rubric:: Everything you need to know about Locust

.. sidebar:: About locust

Locust is a scalable load testing framework written in Python

* **Website**: `http://locust.io <http://locust.io>`_
* **Source code**: `http://github.com/locustio/locust <http://github.com/locustio/locust>`_
* **Twitter**: `@locustio <http://twitter.com/locustio>`_


.. toctree ::
:maxdepth: 2
what-is-locust
installation
quickstart
writing-a-locustfile
api
extending-locust
changelog
=====================
Locust Documentation
=====================

.. rubric:: Everything you need to know about Locust

.. sidebar:: About locust

Locust is a scalable load testing framework written in Python

* **Website**: `http://locust.io <http://locust.io>`_
* **Source code**: `http://github.com/locustio/locust <http://github.com/locustio/locust>`_
* **Twitter**: `@locustio <http://twitter.com/locustio>`_


.. toctree ::
:maxdepth: 2
what-is-locust
installation
quickstart
writing-a-locustfile
api
extending-locust
changelog
106 changes: 53 additions & 53 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
Installation
============

Locust is available on PyPI and can be installed through pip or easy_install

::

pip install locustio

or::

easy_install locustio

When 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::

locust --help


Installing ZeroMQ
-----------------

If you intend to run Locust distributed across multiple processes/machines, we recommend you to also
install **pyzmq**::

pip install pyzmq

or::

easy_install pyzmq

Installing Locust on Windows
----------------------------

The easiest way to get Locust running on Windows is to first install pre built binary packages for
gevent (0.13) and greenlet and then follow the above instructions.

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/>`_

Installing Locust on OS X
----------------------------

The following is currently the shortest path to installing gevent on OS X using Homebrew.

#. Install [Homebrew](http://mxcl.github.com/homebrew/).
#. Install libevent (dependency for gevent)::

brew install libevent

#. Then follow the above instructions.
Installation
============

Locust is available on PyPI and can be installed through pip or easy_install

::

pip install locustio

or::

easy_install locustio

When 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::

locust --help


Installing ZeroMQ
-----------------

If you intend to run Locust distributed across multiple processes/machines, we recommend you to also
install **pyzmq**::

pip install pyzmq

or::

easy_install pyzmq

Installing Locust on Windows
----------------------------

The easiest way to get Locust running on Windows is to first install pre built binary packages for
gevent (0.13) and greenlet and then follow the above instructions.

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/>`_

Installing Locust on OS X
----------------------------

The following is currently the shortest path to installing gevent on OS X using Homebrew.

#. Install [Homebrew](http://mxcl.github.com/homebrew/).
#. Install libevent (dependency for gevent)::

brew install libevent

#. Then follow the above instructions.
Loading

0 comments on commit a58c469

Please sign in to comment.