kallithea Changeset - 8c234ae2c258

Changeset - 8c234ae2c258

Parent rev.

Child rev.

[Not reviewed]

stable

0 4 0

Mads Kiilerich - 10 years ago 2015-09-25 14:18:44
madski@unity3d.com

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 .

4 files changed with 7 insertions and 1 deletions:

docs/contributing.rst

docs/installation.rst

docs/installation_win.rst

docs/installation_win_old.rst

0 comments (0 inline, 0 general)

docs/contributing.rst

➞

Show inline comments

@@ @@ -25,24 +25,25 @@ To register, you can use your Bitbucket @@
 for more details.
 Getting started
 ---------------
 To get started with development::
         hg clone https://kallithea-scm.org/repos/kallithea
         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
         paster serve my.ini --reload &
         firefox http://127.0.0.1:5000/
 You can also start out by forking https://bitbucket.org/conservancy/kallithea
 on Bitbucket_ and create a local clone of your own fork.
 Running tests
 -------------

docs/installation.rst

➞

Show inline comments

@@ @@ -30,24 +30,25 @@ The following describes three different @@
 Installation from repository source
 -----------------------------------
 To install Kallithea in a virtualenv_ using the stable branch of the development
 repository, follow the instructions below::
         hg clone https://kallithea-scm.org/repos/kallithea -u stable
         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
 You can now proceed to :ref:`setup`.
 To upgrade, simply update the repository with ``hg pull -u`` and restart the
 server.
 .. _installation-virtualenv:
 Installing a released version in a virtualenv
@@ @@ -55,27 +56,29 @@ Installing a released version in a virtu @@
 It is highly recommended to use a separate virtualenv_ for installing Kallithea.
 This way, all libraries required by Kallithea will be installed separately from your
 main Python installation and other applications and things will be less
 problematic when upgrading the system or Kallithea.
 An additional benefit of virtualenv_ is that it doesn't require root privileges.
 - Assuming you have installed virtualenv_, create a new virtual environment
   for example, in `/srv/kallithea/venv`, using the virtualenv command::
     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
    acceptable (and desirable) to create a virtualenv as a normal user.
 - Make a folder for Kallithea data files, and configuration somewhere on the
   filesystem. For example::
     mkdir /srv/kallithea
 - Go into the created directory and run this command to install Kallithea::

docs/installation_win.rst

➞

Show inline comments

@@ @@ -125,24 +125,25 @@ In order to install Kallithea, you need @@
 Some Python packages use managed code and need to be compiled.
 This can be done on Linux without any special steps. On Windows, you will need to install Microsoft Visual C++ compiler for Python 2.7.
 Download and install "Microsoft Visual C++ Compiler for Python 2.7" from http://aka.ms/vcpython27
 .. note::
   You can also install the dependencies using already compiled Windows binaries packages. A good source of compiled Python packages is http://www.lfd.uci.edu/~gohlke/pythonlibs/. However, not all of the necessary packages for Kallithea are on this site and some are hard to find, so we will stick with using the compiler.
 In a command prompt type (adapting paths if necessary)::
   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::
   pip install kallithea
 .. note:: This will take some time. Please wait patiently until it is fully
           complete. Some warnings will appear. Don't worry, they are
           normal.
 Step 8 -- Install git (optional)
 --------------------------------

docs/installation_win_old.rst

➞

Show inline comments

@@ @@ -174,24 +174,25 @@ Command Prompt (**IMPORTANT!!**). To do @@
 Change commandline from::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" x86
 to::
 %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64
 In that CMD (loaded with VS2008 PATHs) type::
   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::
  pip install kallithea
 (long step, please wait until fully complete)
 Some warnings will appear, don't worry as they are normal.
 Step 8 -- Configuring Kallithea
 -------------------------------

0 comments (0 inline, 0 general)