diff --git a/python/README.rst b/python/README.rst index 7eb923ded4..864f7a1b27 100644 --- a/python/README.rst +++ b/python/README.rst @@ -6,7 +6,7 @@ Python client for Swift Binary Protocol (SBP). Setup ----- -Youmust have `python` and `pip` installed. +You must have `python` and `pip` installed. Install dependencies only:: @@ -20,6 +20,23 @@ Install package from pypi:: $ sudo pip install sbp +Setup using a virtual environment +----- + +Setup and activate the `virtualenv`:: + + $ virtualenv .env && source .env/bin/activate + +Install `py.test` in the virtualenv:: + + $ pip install pytest-virtualenv + +Install the `pt.test` coverage tools:: + + $ pip install pytest-cov + +Finally, proceed to the standard setup instructions. + Usage Examples --------------