From aa41127ef7987cd5c64d61e6be6c33b502f973ab Mon Sep 17 00:00:00 2001 From: Terry Howe Date: Tue, 8 Dec 2015 15:43:06 -0700 Subject: [PATCH] Change documentation to install from pypi Change-Id: I46fe46d0af14563b2e87492c2abe1b39ec246714 --- README.rst | 9 ++++++++- doc/source/installation.rst | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 746cda0c1..bb280c89a 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,7 @@ similarly configured jobs is easy. To install:: - $ sudo python setup.py install + $ pip install --user jenkins-job-builder Online documentation: @@ -29,6 +29,13 @@ Cloning:: git clone https://git.openstack.org/openstack-infra/jenkins-job-builder +A virtual environment is recommended for development. For example, Jenkins +Job Builder may be installed from the top level directory:: + + $ virtualenv .venv + $ source .venv/bin/activate + $ pip install -r test-requirements.txt -e . + Patches are submitted via Gerrit at: * https://review.openstack.org/ diff --git a/doc/source/installation.rst b/doc/source/installation.rst index aeb911905..9187451eb 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -3,7 +3,14 @@ Installation To install Jenkins Job Builder from source, run:: - sudo python setup.py install + pip install --user jenkins-job-builder + +A virtual environment is recommended for development. For example, Jenkins +Job Builder may be installed from the top level directory:: + + $ virtualenv .venv + $ source .venv/bin/activate + $ pip install -r test-requirements.txt -e . Alternatively, the current release can be installed from pypi::