From ce44e8782400657b049be26250ac1f2b38a4fd7a Mon Sep 17 00:00:00 2001 From: John Chilton Date: Fri, 26 Aug 2016 23:44:53 -0400 Subject: [PATCH] Fixup documentation regarding installs. --- .travis.yml | 2 -- README.rst | 35 ++++++++++++++++------------------- docs/installation.rst | 2 +- 3 files changed, 17 insertions(+), 22 deletions(-) diff --git a/.travis.yml b/.travis.yml index a52762449..490085d65 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,6 @@ env: - TOX_ENV=py27-quick - TOX_ENV=py27 - TOX_ENV=py34 - - TOX_ENV=py27-lint-imports - TOX_ENV=py27-lint-docstrings install: @@ -21,7 +20,6 @@ install: matrix: allow_failures: - env: TOX_ENV=py34 - - env: TOX_ENV=py27-lint-imports - env: TOX_ENV=py27-lint-docstrings script: PLANEMO_ENABLE_POSTGRES_TESTS=1 PLANEMO_SKIP_CWLTOOL_TESTS=1 tox -e $TOX_ENV diff --git a/README.rst b/README.rst index 4ae56beb1..e80db6d03 100644 --- a/README.rst +++ b/README.rst @@ -33,35 +33,32 @@ develop Galaxy tools. Obtaining Planemo ----------------- -The recommended approach for installing Planemo is to use Homebrew_ or -linuxbrew_. To install Planemo this way use the ``brew`` command as -follows. +For a traditional Python installation of Planemo, first set up a virtualenv +for ``planemo`` (this example creates a new one in ``.venv``) and then +install with ``pip``. Planemo requires pip 7.0 or newer. :: - $ brew tap galaxyproject/tap - $ brew install planemo + $ virtualenv .venv; . .venv/bin/activate + $ pip install "pip>=7" # Upgrade pip if needed. + $ pip install planemo - -Planemo can alternatively be installed via Conda_: +Another approach for installing Planemo is to use Homebrew_ or +linuxbrew_. To install Planemo this way use the ``brew`` command as +follows. :: - $ conda config --add channels r - $ conda config --add channels bioconda - $ conda install planemo - -For third option and a more traditional Python installation set up a virtualenv -for Planemo (this example creates a new one in ``.venv/``) and then -install it with ``pip``. - -:: + $ brew tap galaxyproject/tap + $ brew install planemo - $ virtualenv .venv; . .venv/bin/activate - $ pip install planemo +For information on updating Planemo, installing the latest development release, +or installing planemo via bioconda - checkout the `installation +`__ +documentation. Planemo is also available as a `virtual appliance -`_ bundled +`_ bundled with a preconfigured Galaxy server and set up for Galaxy tool development. You can choose from open virtualization format (OVA_, .ova), Docker_, or Vagrant_ appliances. diff --git a/docs/installation.rst b/docs/installation.rst index 19aef079f..9fd186c46 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,7 +5,7 @@ Installation pip_ ============ -For a more traditional Python installation of Planemo set up a virtualenv +For a traditional Python installation of Planemo, first set up a virtualenv for ``planemo`` (this example creates a new one in ``.venv``) and then install with ``pip``. Planemo requires pip 7.0 or newer.