From 091e3aaf662f04d5073ea502b896607f79d306ac Mon Sep 17 00:00:00 2001 From: lance Date: Sat, 20 Jan 2018 00:10:04 -0800 Subject: [PATCH 1/2] adding block about installing deps to venv --- docs/source/quickstart.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 99a9123..fa959f4 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -56,7 +56,23 @@ a JSON RPC interface. Start it by typing: $ monero-wallet-rpc --testnet --wallet-file testwallet --password "" --rpc-bind-port 28088 --disable-rpc-login -Now everything is ready to start using Python. +Now you're almost ready to start using Python. + +Install Dependencies +--------------------- + +Before you can use the library, you first must download the Python library dependencies with ``pip``. It is recommended to use a `virtual environment`_ to isolate library versions. Assuming you have ``virtualenv`` installed to your system, set up a new env, activate it, and install the dependencies. + +.. _`virtual environment`: https://averlytics.com/2017/08/06/virtual-environment-a-python-best-practice/ + +.. code-block:: shell + + $ virtualenv .venv + $ source .venv/bin/activate + $ pip install -r requirements.txt + $ python + +Now you can proceed. Connect to the wallet --------------------- From 4a95828d99a5a8aee96592de0fd3744670bd7461 Mon Sep 17 00:00:00 2001 From: lance Date: Sat, 20 Jan 2018 00:10:44 -0800 Subject: [PATCH 2/2] adding venv dirs to gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index e54dfd8..63d71f5 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ *.bak *.swp docs/build/* +.venv +venv