changeset 5519:8c234ae2c258 stable

docs: add advice of upgrading pip and setuptools in new virtualenvs Withtout this, the new virtualenv might have setuptools version 12 while the URLObject dependency mock fails because it requires setuptools>=17.1 .
author Mads Kiilerich <madski@unity3d.com>
date Fri, 25 Sep 2015 14:18:44 +0200
parents 8a1166a465fe
children 4e9f5ef98dc4
files docs/contributing.rst docs/installation.rst docs/installation_win.rst docs/installation_win_old.rst
diffstat 4 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/docs/contributing.rst	Fri Sep 25 12:50:03 2015 +0200
+++ b/docs/contributing.rst	Fri Sep 25 14:18:44 2015 +0200
@@ -34,6 +34,7 @@
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
+        pip install --upgrade pip setuptools
         python2 setup.py develop
         paster make-config Kallithea my.ini
         paster setup-db my.ini --user=user --email=user@example.com --password=password --repos=/tmp
--- a/docs/installation.rst	Fri Sep 25 12:50:03 2015 +0200
+++ b/docs/installation.rst	Fri Sep 25 14:18:44 2015 +0200
@@ -39,6 +39,7 @@
         cd kallithea
         virtualenv ../kallithea-venv
         source ../kallithea-venv/bin/activate
+        pip install --upgrade pip setuptools
         python2 setup.py develop
         python2 setup.py compile_catalog   # for translation of the UI
 
@@ -64,9 +65,11 @@
 
     virtualenv /srv/kallithea/venv
 
-- Activate the virtualenv_ in your current shell session by running::
+- Activate the virtualenv_ in your current shell session and make sure the
+  basic requirements are up-to-date by running::
 
     source /srv/kallithea/venv/bin/activate
+    pip install --upgrade pip setuptools
 
 .. note:: You can't use UNIX ``sudo`` to source the ``virtualenv`` script; it
    will "activate" a shell that terminates immediately. It is also perfectly
--- a/docs/installation_win.rst	Fri Sep 25 12:50:03 2015 +0200
+++ b/docs/installation_win.rst	Fri Sep 25 14:18:44 2015 +0200
@@ -134,6 +134,7 @@
 
   cd C:\Kallithea\Env\Scripts
   activate
+  pip install --upgrade pip setuptools
 
 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
 (depending of your folder structure). Then type::
--- a/docs/installation_win_old.rst	Fri Sep 25 12:50:03 2015 +0200
+++ b/docs/installation_win_old.rst	Fri Sep 25 14:18:44 2015 +0200
@@ -183,6 +183,7 @@
 
   cd C:\Kallithea\Env\Scripts (or similar)
   activate
+  pip install --upgrade pip setuptools
 
 The prompt will change into "(Env) C:\\Kallithea\\Env\\Scripts" or similar
 (depending of your folder structure). Then type::