setup: don't use setuptools 34 - it has indirect conflicts with the celery version supported on the stable branch (Issue #266)

Setuptools==34 requires packaging>=16.8 which has an unconstrained requirement
of pyparsing ... but actually it doesn't work with pyparsing==1.5.7 ... which
is required by celery<2.3 ... which this version of Kallithea requires.

Celery has been upgraded on the development branch but we don't want to do that
on the stable branch.

docs/contributing.rst

@@ -1,160 +1,160 b''
 .. _contributing:
 
 =========================
 Contributing to Kallithea
 =========================
 
 Kallithea is developed and maintained by its users. Please join us and scratch
 your own itch.
 
 
 Infrastructure
 --------------
 
 The main repository is hosted on Our Own Kallithea (aka OOK) at
 https://kallithea-scm.org/repos/kallithea/, our self-hosted instance
 of Kallithea.
 
 For now, we use Bitbucket_ for `pull requests`_ and `issue tracking`_. The
 issue tracker is for tracking bugs, not for support, discussion, or ideas --
 please use the `mailing list`_ or :ref:`IRC <readme>` to reach the community.
 
 We use Weblate_ to translate the user interface messages into languages other
 than English. Join our project on `Hosted Weblate`_ to help us.
 To register, you can use your Bitbucket or GitHub account. See :ref:`translations`
 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
+        pip install --upgrade pip "setuptools<34"
         pip install -e .
         paster make-config Kallithea my.ini
         paster setup-db my.ini --user=user --email=[e-mail] --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
 -------------
 
 After finishing your changes make sure all tests pass cleanly. You can run
 the testsuite running ``nosetests`` from the project root, or if you use tox
 run ``tox`` for Python 2.6--2.7 with multiple database test.
 
 When running tests, Kallithea uses `kallithea/tests/test.ini` and populates the
 SQLite database specified there.
 
 It is possible to avoid recreating the full test database on each invocation of
 the tests, thus eliminating the initial delay. To achieve this, run the tests as::
 
     paster serve kallithea/tests/test.ini --pid-file=test.pid --daemon
     KALLITHEA_WHOOSH_TEST_DISABLE=1 KALLITHEA_NO_TMP_PATH=1 nosetests
     kill -9 $(cat test.pid)
 
 You can run individual tests by specifying their path as argument to nosetests.
 nosetests also has many more options, see `nosetests -h`. Some useful options
 are::
 
     -x, --stop            Stop running tests after the first error or failure
     -s, --nocapture       Don't capture stdout (any stdout output will be
                           printed immediately) [NOSE_NOCAPTURE]
     --failed              Run the tests that failed in the last test run.
 
 
 Coding/contribution guidelines
 ------------------------------
 
 Kallithea is GPLv3 and we assume all contributions are made by the
 committer/contributor and under GPLv3 unless explicitly stated. We do care a
 lot about preservation of copyright and license information for existing code
 that is brought into the project.
 
 We don't have a formal coding/formatting standard. We are currently using a mix
 of Mercurial's (https://www.mercurial-scm.org/wiki/CodingStyle), pep8, and
 consistency with existing code. Run whitespacecleanup.sh to avoid stupid
 whitespace noise in your patches.
 
 We support both Python 2.6.x and 2.7.x and nothing else. For now we don't care
 about Python 3 compatibility.
 
 We try to support the most common modern web browsers. IE9 is still supported
 to the extent it is feasible, IE8 is not.
 
 We primarily support Linux and OS X on the server side but Windows should also work.
 
 HTML templates should use 2 spaces for indentation ... but be pragmatic. We
 should use templates cleverly and avoid duplication. We should use reasonable
 semantic markup with element classes and IDs that can be used for styling and testing.
 We should only use inline styles in places where it really is semantic (such as
 ``display: none``).
 
 JavaScript must use ``;`` between/after statements. Indentation 4 spaces. Inline
 multiline functions should be indented two levels -- one for the ``()`` and one for
 ``{}``.
 Variables holding jQuery objects should be named with a leading ``$``.
 
 Commit messages should have a leading short line summarizing the changes. For
 bug fixes, put ``(Issue #123)`` at the end of this line.
 
 Use American English grammar and spelling overall. Use `English title case`_ for
 page titles, button labels, headers, and 'labels' for fields in forms.
 
 .. _English title case: https://en.wikipedia.org/wiki/Capitalization#Title_case
 
 Contributions will be accepted in most formats -- such as pull requests on
 bitbucket, something hosted on your own Kallithea instance, or patches sent by
 email to the `kallithea-general`_ mailing list.
 
 Make sure to test your changes both manually and with the automatic tests
 before posting.
 
 We care about quality and review and keeping a clean repository history. We
 might give feedback that requests polishing contributions until they are
 "perfect". We might also rebase and collapse and make minor adjustments to your
 changes when we apply them.
 
 We try to make sure we have consensus on the direction the project is taking.
 Everything non-sensitive should be discussed in public -- preferably on the
 mailing list.  We aim at having all non-trivial changes reviewed by at least
 one other core developer before pushing. Obvious non-controversial changes will
 be handled more casually.
 
 For now we just have one official branch ("default") and will keep it so stable
 that it can be (and is) used in production. Experimental changes should live
 elsewhere (for example in a pull request) until they are ready.
 
 .. _translations:
 .. include:: ./../kallithea/i18n/how_to
 
 
 "Roadmap"
 ---------
 
 We do not have a road map but are waiting for your contributions. Refer to the
 wiki_ for some ideas of places we might want to go -- contributions in these
 areas are very welcome.
 
 
 Thank you for your contribution!
 --------------------------------
 
 
 .. _Weblate: http://weblate.org/
 .. _issue tracking: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open
 .. _pull requests: https://bitbucket.org/conservancy/kallithea/pull-requests
 .. _bitbucket: http://bitbucket.org/
 .. _mailing list: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general
 .. _kallithea-general: http://lists.sfconservancy.org/mailman/listinfo/kallithea-general
 .. _Hosted Weblate: https://hosted.weblate.org/projects/kallithea/kallithea/
 .. _wiki: https://bitbucket.org/conservancy/kallithea/wiki/Home

docs/installation.rst

@@ -1,212 +1,212 b''
 .. _installation:
 
 ==========================
 Installation on Unix/Linux
 ==========================
 
 The following describes three different ways of installing Kallithea:
 
 - :ref:`installation-source`: The simplest way to keep the installation
   up-to-date and track any local customizations is to run directly from
   source in a Kallithea repository clone, preferably inside a virtualenv
   virtual Python environment.
 
 - :ref:`installation-virtualenv`: If you prefer to only use released versions
   of Kallithea, the recommended method is to install Kallithea in a virtual
   Python environment using `virtualenv`. The advantages of this method over
   direct installation is that Kallithea and its dependencies are completely
   contained inside the virtualenv (which also means you can have multiple
   installations side by side or remove it entirely by just removing the
   virtualenv directory) and does not require root privileges.
 
 - :ref:`installation-without-virtualenv`: The alternative method of installing
   a Kallithea release is using standard pip. The package will be installed in
   the same location as all other Python packages you have ever installed. As a
   result, removing it is not as straightforward as with a virtualenv, as you'd
   have to remove its dependencies manually and make sure that they are not
   needed by other packages.
 
 .. _installation-source:
 
 
 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
+        pip install --upgrade pip "setuptools<34"
         pip install -e .
         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
 ---------------------------------------------
 
 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 and make sure the
   basic requirements are up-to-date by running::
 
     source /srv/kallithea/venv/bin/activate
-    pip install --upgrade pip setuptools
+    pip install --upgrade pip "setuptools<34"
 
 .. 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.
 
 .. note:: Some dependencies are optional. If you need them, install them in
    the virtualenv too::
 
      pip install psycopg2
      pip install python-ldap
 
    This might require installation of development packages using your
    distribution's package manager.
 
 - 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::
 
     pip install kallithea
 
   Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
   extract it and run::
 
     pip install .
 
 - This will install Kallithea together with pylons_ and all other required
   python libraries into the activated virtualenv.
 
 You can now proceed to :ref:`setup`.
 
 .. _installation-without-virtualenv:
 
 
 Installing a released version without virtualenv
 ------------------------------------------------
 
 For installation without virtualenv, 'just' use::
 
     pip install kallithea
 
 Note that this method requires root privileges and will install packages
 globally without using the system's package manager.
 
 To install as a regular user in ``~/.local``, you can use::
 
     pip install --user kallithea
 
 You can now proceed to :ref:`setup`.
 
 
 Upgrading Kallithea from Python Package Index (PyPI)
 ----------------------------------------------------
 
 .. note::
    It is strongly recommended that you **always** perform a database and
    configuration backup before doing an upgrade.
 
    These directions will use '{version}' to note that this is the version of
    Kallithea that these files were used with.  If backing up your Kallithea
    instance from version 0.1 to 0.2, the ``my.ini`` file could be
    backed up to ``my.ini.0-1``.
 
 If using a SQLite database, stop the Kallithea process/daemon/service, and
 then make a copy of the database file::
 
  service kallithea stop
  cp kallithea.db kallithea.db.{version}
 
 Back up your configuration file::
 
  cp my.ini my.ini.{version}
 
 Ensure that you are using the Python virtual environment that you originally
 installed Kallithea in by running::
 
  pip freeze
 
 This will list all packages installed in the current environment.  If
 Kallithea isn't listed, activate the correct virtual environment::
 
  source /srv/kallithea/venv/bin/activate
 
 Once you have verified the environment you can upgrade Kallithea with::
 
  pip install --upgrade kallithea
 
 Then run the following command from the installation directory::
 
  paster make-config Kallithea my.ini
 
 This will display any changes made by the new version of Kallithea to your
 current configuration. It will try to perform an automerge. It is recommended
 that you recheck the content after the automerge.
 
 .. note::
    Please always make sure your .ini files are up to date. Errors can
    often be caused by missing parameters added in new versions.
 
 It is also recommended that you rebuild the whoosh index after upgrading since
 the new whoosh version could introduce some incompatible index changes. Please
 read the changelog to see if there were any changes to whoosh.
 
 The final step is to upgrade the database. To do this simply run::
 
  paster upgrade-db my.ini
 
 This will upgrade the schema and update some of the defaults in the database,
 and will always recheck the settings of the application, if there are no new
 options that need to be set.
 
 .. note::
    The DB schema upgrade library has some limitations and can sometimes fail if you try to
    upgrade from older major releases. In such a case simply run upgrades sequentially, e.g.,
    upgrading from 0.1.X to 0.3.X should be done like this: 0.1.X. > 0.2.X > 0.3.X
    You can always specify what version of Kallithea you want to install for example in pip
    `pip install Kallithea==0.2`
 
 You may find it helpful to clear out your log file so that new errors are
 readily apparent::
 
  echo > kallithea.log
 
 Once that is complete, you may now start your upgraded Kallithea Instance::
 
  service kallithea start
 
 Or::
 
  paster serve /srv/kallithea/my.ini
 
 .. note::
    If you're using Celery, make sure you restart all instances of it after
    upgrade.
 
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _pylons: http://www.pylonsproject.org/

docs/installation_win.rst

@@ -1,245 +1,245 b''
 .. _installation_win:
 
 ================================================================
 Installation and upgrade on Windows (7/Server 2008 R2 and newer)
 ================================================================
 
 
 First time install
 ::::::::::::::::::
 
 Target OS: Windows 7 and newer or Windows Server 2008 R2 and newer
 
 Tested on Windows 8.1, Windows Server 2008 R2 and Windows Server 2012
 
 To install on an older version of Windows, see `<installation_win_old.html>`_
 
 Step 1 -- Install Python
 ------------------------
 
 Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side.
 
 .. warning:: Python 3.x is not supported.
 
 - Download Python 2.x.y from http://www.python.org/download/
 - Choose and click on the version
 - Click on "Windows X86-64 Installer" for x64 or "Windows x86 MSI installer" for Win32.
 - Disable UAC or run the installer with admin privileges. If you chose to disable UAC, do not forget to reboot afterwards.
 
 While writing this guide, the latest version was v2.7.9.
 Remember the specific major and minor versions installed, because they will
 be needed in the next step. In this case, it is "2.7".
 
 Step 2 -- Python BIN
 --------------------
 
 Add Python BIN folder to the path. This can be done manually (editing
 "PATH" environment variable) or by using Windows Support Tools that
 come pre-installed in Windows Vista/7 and later.
 
 Open a CMD and type::
 
   SETX PATH "%PATH%;[your-python-path]" /M
 
 Please substitute [your-python-path] with your Python installation
 path. Typically this is ``C:\\Python27``.
 
 Step 3 -- Install pywin32 extensions
 ------------------------------------
 
 Download pywin32 from:
 http://sourceforge.net/projects/pywin32/files/
 
 - Click on "pywin32" folder
 - Click on the first folder (in this case, Build 219, maybe newer when you try)
 - Choose the file ending with ".amd64-py2.x.exe" (".win32-py2.x.exe"
   for Win32) where x is the minor version of Python you installed.
   When writing this guide, the file was:
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download
   (x64)
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
   (Win32)
 
 Step 4 -- Install pip
 ---------------------
 
 pip is a package management system for Python. You will need it to install Kallithea and its dependencies.
 
 If you installed Python 2.7.9+, you already have it (as long as you ran the installer with admin privileges or disabled UAC).
 
 If it was not installed or if you are using Python>=2.6,<2.7.9:
 
 - Go to https://bootstrap.pypa.io
 - Right-click on get-pip.py and choose Saves as...
 - Run "python2 get-pip.py" in the folder where you downloaded get-pip.py (may require admin access).
 
 .. note::
 
    See http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows
    for details and alternative methods.
 
 Note that pip.exe will be placed inside your Python installation's
 Scripts folder, which is likely not on your path. To correct this,
 open a CMD and type::
 
   SETX PATH "%PATH%;[your-python-path]\Scripts" /M
 
 Step 5 -- Kallithea folder structure
 ------------------------------------
 
 Create a Kallithea folder structure.
 
 This is only an example to install Kallithea. Of course, you can
 change it. However, this guide will follow the proposed structure, so
 please later adapt the paths if you change them. Folders without
 spaces are recommended.
 
 Create the following folder structure::
 
   C:\Kallithea
   C:\Kallithea\Bin
   C:\Kallithea\Env
   C:\Kallithea\Repos
 
 Step 6 -- Install virtualenv
 ----------------------------
 
 .. note::
    A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
    It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa.
 
 In a command prompt type::
 
   pip install virtualenv
 
 Virtualenv will now be inside your Python Scripts path (C:\\Python27\\Scripts or similar).
 
 To create a virtual environment, run::
 
   virtualenv C:\Kallithea\Env
 
 Step 7 -- Install Kallithea
 ---------------------------
 
 In order to install Kallithea, you need to be able to run "pip install kallithea". It will use pip to install the Kallithea Python package and its dependencies.
 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
+  pip install --upgrade pip "setuptools<34"
 
 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)
 --------------------------------
 
 Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
 
 You need to install git manually if you want Kallithea to be able to host git repositories.
 
 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
 
 Step 9 -- Configuring Kallithea
 -------------------------------
 
 Steps taken from `<setup.html>`_
 
 You have to use the same command prompt as in Step 7, so if you closed
 it, reopen it following the same commands (including the "activate"
 one). When ready, type::
 
   cd C:\Kallithea\Bin
   paster make-config Kallithea production.ini
 
 Then you must edit production.ini to fit your needs (IP address, IP
 port, mail settings, database, etc.). `NotePad++`__ or a similar text
 editor is recommended to properly handle the newline character
 differences between Unix and Windows.
 
 __ http://notepad-plus-plus.org/
 
 For the sake of simplicity, run it with the default settings. After your edits (if any) in the previous command prompt, type::
 
   paster setup-db production.ini
 
 .. warning:: This time a *new* database will be installed. You must
              follow a different step to later *upgrade* to a newer
              Kallithea version)
 
 The script will ask you for confirmation about creating a new database, answer yes (y)
 
 The script will ask you for the repository path, answer C:\\Kallithea\\Repos (or similar).
 
 The script will ask you for the admin username and password, answer "admin" + "123456" (or whatever you want)
 
 The script will ask you for admin mail, answer "[e-mail]" (or whatever you want).
 
 If you make a mistake and the script doesn't end, don't worry: start it again.
 
 If you decided not to install git, you will get errors about it that you can ignore.
 
 Step 10 -- Running Kallithea
 ----------------------------
 
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type::
 
   paster serve production.ini
 
 Open your web server, and go to http://127.0.0.1:5000
 
 It works!! :-)
 
 Remark:
 If it does not work the first time, Ctrl-C the CMD process and start it again. Don't forget the "http://" in Internet Explorer.
 
 What this guide does not cover:
 
 - Installing Celery
 - Running Kallithea as a Windows Service. You can investigate here:
 
   - http://pypi.python.org/pypi/wsgisvc
   - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/
   - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service
 
 - Using Apache. You can investigate here:
 
   - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4
 
 
 Upgrading
 :::::::::
 
 Stop running Kallithea
 Open a CommandPrompt like in Step 7 (cd to C:\Kallithea\Env\Scripts and activate) and type::
 
   pip install kallithea --upgrade
   cd \Kallithea\Bin
 
 Backup your production.ini file now.
 
 Then run::
 
   paster make-config Kallithea production.ini
 
 Look for changes and update your production.ini accordingly.
 
 Next, update the database::
 
   paster upgrade-db production.ini
 
 More details can be found in `<upgrade.html>`_.

docs/installation_win_old.rst

@@ -1,282 +1,282 b''
 .. _installation_win_old:
 
 ======================================================================
 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
 ======================================================================
 
 
 First-time install
 ::::::::::::::::::
 
 Target OS: Windows XP SP3 32-bit English (Clean installation)
 + All Windows Updates until 24-may-2012
 
 .. note::
 
    This installation is for 32-bit systems, for 64-bit Windows you might need
    to download proper 64-bit versions of the different packages (Windows Installer, Win32py extensions)
    plus some extra tweaks.
    These extra steps haven been marked as "64-bit".
    Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
    If you run into any 64-bit related problems, please check these pages:
 
    - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
    - http://bugs.python.org/issue7511
 
 Step 1 -- Install Visual Studio 2008 Express
 --------------------------------------------
 
 Optional: You can also install MinGW, but VS2008 installation is easier.
 
 Download "Visual C++ 2008 Express Edition with SP1" from:
 http://download.microsoft.com/download/E/8/E/E8EEB394-7F42-4963-A2D8-29559B738298/VS2008ExpressWithSP1ENUX1504728.iso
 (if not found or relocated, google for "visual studio 2008 express" for updated link. This link was taken from http://stackoverflow.com/questions/15318560/visual-c-2008-express-download-link-dead)
 
 You can also download full ISO file for offline installation, just
 choose "All -- Offline Install ISO image file" in the previous page and
 choose "Visual C++ 2008 Express" when installing.
 
 .. note::
 
    Using other versions of Visual Studio will lead to random crashes.
    You must use Visual Studio 2008!"
 
 .. note::
 
    Silverlight Runtime and SQL Server 2008 Express Edition are not
    required, you can uncheck them
 
 .. note::
 
    64-bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
    Download from: http://www.microsoft.com/en-us/download/details.aspx?id=3138
 
 .. note::
 
    64-bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.
    I am not sure why this is not necessary for 32-bit.
    Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
 
 Step 2 -- Install Python
 ------------------------
 
 Install Python 2.x.y (x = 6 or 7) x86 version (32-bit). DO NOT USE A 3.x version.
 Download Python 2.x.y from:
 http://www.python.org/download/
 
 Choose "Windows Installer" (32-bit version) not "Windows X86-64
 Installer". While writing this guide, the latest version was v2.7.3.
 Remember the specific major and minor version installed, because it will
 be needed in the next step. In this case, it is "2.7".
 
 .. note::
 
    64-bit: Just download and install the 64-bit version of python.
 
 Step 3 -- Install Win32py extensions
 ------------------------------------
 
 Download pywin32 from:
 http://sourceforge.net/projects/pywin32/files/
 
 - Click on "pywin32" folder
 - Click on the first folder (in this case, Build 217, maybe newer when you try)
 - Choose the file ending with ".win32-py2.x.exe" -> x being the minor
   version of Python you installed (in this case, 7)
   When writing this guide, the file was:
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20217/pywin32-217.win32-py2.7.exe/download
 
   .. note::
 
      64-bit: Download and install the 64-bit version.
      At the time of writing you can find this at:
      http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 
 Step 4 -- Python BIN
 --------------------
 
 Add Python BIN folder to the path
 
 You have to add the Python folder to the path, you can do it manually
 (editing "PATH" environment variable) or using Windows Support Tools
 that came preinstalled in Vista/7 and can be installed in Windows XP.
 
 - Using support tools on WINDOWS XP:
   If you use Windows XP you can install them using Windows XP CD and
   navigating to \SUPPORT\TOOLS. There, execute Setup.EXE (not MSI).
   Afterwards, open a CMD and type::
 
     SETX PATH "%PATH%;[your-python-path]" -M
 
   Close CMD (the path variable will be updated then)
 
 - Using support tools on WINDOWS Vista/7:
 
   Open a CMD and type::
 
     SETX PATH "%PATH%;[your-python-path]" /M
 
   Please substitute [your-python-path] with your Python installation path.
   Typically: C:\\Python27
 
 Step 5 -- Kallithea folder structure
 ------------------------------------
 
 Create a Kallithea folder structure
 
 This is only a example to install Kallithea, you can of course change
 it. However, this guide will follow the proposed structure, so please
 later adapt the paths if you change them. My recommendation is to use
 folders with NO SPACES. But you can try if you are brave...
 
 Create the following folder structure::
 
   C:\Kallithea
   C:\Kallithea\Bin
   C:\Kallithea\Env
   C:\Kallithea\Repos
 
 Step 6 -- Install virtualenv
 ----------------------------
 
 Install Virtual Env for Python
 
 Navigate to: http://www.virtualenv.org/en/latest/index.html#installation
 Right click on "virtualenv.py" file and choose "Save link as...".
 Download to C:\\Kallithea (or whatever you want)
 (the file is located at
 https://raw.github.com/pypa/virtualenv/master/virtualenv.py)
 
 Create a virtual Python environment in C:\\Kallithea\\Env (or similar). To
 do so, open a CMD (Python Path should be included in Step3), navigate
 where you downloaded "virtualenv.py", and write::
 
   python2 virtualenv.py C:\Kallithea\Env
 
 (--no-site-packages is now the default behaviour of virtualenv, no need
 to include it)
 
 Step 7 -- Install Kallithea
 ---------------------------
 
 Finally, install Kallithea
 
 Close previously opened command prompt/s, and open a Visual Studio 2008
 Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open
 "Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" ->
 "Visual Studio 2008 Command Prompt"
 
 .. note::
 
    64-bit: For 64-bit you need to modify the shortcut that is used to start the
    Visual Studio 2008 Command Prompt. Use right-mouse click to open properties.
 
 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
+  pip install --upgrade pip "setuptools<34"
 
 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
 -------------------------------
 
 steps taken from http://packages.python.org/Kallithea/setup.html
 
 You have to use the same Visual Studio 2008 command prompt as Step7, so
 if you closed it reopen it following the same commands (including the
 "activate" one). When ready, just type::
 
   cd C:\Kallithea\Bin
   paster make-config Kallithea production.ini
 
 Then, you must edit production.ini to fit your needs (network address and
 port, mail settings, database, whatever). I recommend using NotePad++
 (free) or similar text editor, as it handles well the EndOfLine
 character differences between Unix and Windows
 (http://notepad-plus-plus.org/)
 
 For the sake of simplicity lets run it with the default settings. After
 your edits (if any), in the previous Command Prompt, type::
 
  paster setup-db production.ini
 
 (this time a NEW database will be installed, you must follow a different
 step to later UPGRADE to a newer Kallithea version)
 
 The script will ask you for confirmation about creating a NEW database,
 answer yes (y)
 The script will ask you for repository path, answer C:\\Kallithea\\Repos
 (or similar)
 The script will ask you for admin username and password, answer "admin"
 + "123456" (or whatever you want)
 The script will ask you for admin mail, answer "[e-mail]" (or
 whatever you want)
 
 If you make some mistake and the script does not end, don't worry, start
 it again.
 
 Step 9 -- Running Kallithea
 ---------------------------
 
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
 just type::
 
  paster serve production.ini
 
 Open yout web server, and go to http://127.0.0.1:5000
 
 It works!! :-)
 
 Remark:
 If it does not work first time, just Ctrl-C the CMD process and start it
 again. Don't forget the "http://" in Internet Explorer
 
 What this Guide does not cover:
 
 - Installing Celery
 - Running Kallithea as Windows Service. You can investigate here:
 
   - http://pypi.python.org/pypi/wsgisvc
   - http://ryrobes.com/python/running-python-scripts-as-a-windows-service/
   - http://wiki.pylonshq.com/display/pylonscookbook/How+to+run+Pylons+as+a+Windows+service
 
 - Using Apache. You can investigate here:
 
   - https://groups.google.com/group/rhodecode/msg/c433074e813ffdc4
 
 
 Upgrading
 :::::::::
 
 Stop running Kallithea
 Open a CommandPrompt like in Step7 (VS2008 path + activate) and type::
 
  easy_install -U kallithea
  cd \Kallithea\Bin
 
 { backup your production.ini file now} ::
 
  paster make-config Kallithea production.ini
 
 (check changes and update your production.ini accordingly) ::
 
  paster upgrade-db production.ini (update database)
 
 Full steps in http://packages.python.org/Kallithea/upgrade.html

setup.py

@@ -1,191 +1,192 b''
 #!/usr/bin/env python2
 # -*- coding: utf-8 -*-
 import os
 import sys
 import platform
 
 if sys.version_info < (2, 6):
     raise Exception('Kallithea requires python 2.6 or 2.7')
 
 
 here = os.path.abspath(os.path.dirname(__file__))
 
 
 def _get_meta_var(name, data, callback_handler=None):
     import re
     matches = re.compile(r'(?:%s)\s*=\s*(.*)' % name).search(data)
     if matches:
         if not callable(callback_handler):
             callback_handler = lambda v: v
 
         return callback_handler(eval(matches.groups()[0]))
 
 _meta = open(os.path.join(here, 'kallithea', '__init__.py'), 'rb')
 _metadata = _meta.read()
 _meta.close()
 
 callback = lambda V: ('.'.join(map(str, V[:3])) + '.'.join(V[3:]))
 __version__ = _get_meta_var('VERSION', _metadata, callback)
 __license__ = _get_meta_var('__license__', _metadata)
 __author__ = _get_meta_var('__author__', _metadata)
 __url__ = _get_meta_var('__url__', _metadata)
 # defines current platform
 __platform__ = platform.system()
 
 is_windows = __platform__ in ['Windows']
 
 requirements = [
+    "setuptools<34", # setuptools==34 has an undeclared requirement of pyparsing >=2.1, but celery<2.3 requires pyparsing<2
     "waitress==0.8.8",
     "webob>=1.0.8,<=1.1.1",
     "webtest==1.4.3",
     "Pylons>=1.0.0,<=1.0.2",
     "Beaker==1.6.4",
     "WebHelpers==1.3",
     "formencode>=1.2.4,<=1.2.6",
     "SQLAlchemy==0.7.10",
     "Mako>=0.9.0,<=1.0.0",
     "pygments>=1.5",
     "whoosh>=2.4.0,<=2.5.7",
     "celery>=2.2.5,<2.3",
     "babel>=0.9.6,<=1.3",
     "python-dateutil>=1.5.0,<2.0.0",
     "markdown==2.2.1",
     "docutils>=0.8.1,<=0.11",
     "mock",
     "URLObject==2.3.4",
     "Routes==1.13",
     "dulwich>=0.9.9,<=0.9.9",
     "mercurial>=2.9,<3.8",
 ]
 
 if sys.version_info < (2, 7):
     requirements.append("importlib==1.0.1")
     requirements.append("unittest2")
     requirements.append("argparse")
 
 if not is_windows:
     requirements.append("py-bcrypt>=0.3.0,<=0.4")
 
 
 dependency_links = [
 ]
 
 classifiers = [
     'Development Status :: 4 - Beta',
     'Environment :: Web Environment',
     'Framework :: Pylons',
     'Intended Audience :: Developers',
     'License :: OSI Approved :: GNU General Public License (GPL)',
     'Operating System :: OS Independent',
     'Programming Language :: Python',
     'Programming Language :: Python :: 2.6',
     'Programming Language :: Python :: 2.7',
     'Topic :: Software Development :: Version Control',
 ]
 
 
 # additional files from project that goes somewhere in the filesystem
 # relative to sys.prefix
 data_files = []
 
 # additional files that goes into package itself
 package_data = {'kallithea': ['i18n/*/LC_MESSAGES/*.mo', ], }
 
 description = ('Kallithea is a fast and powerful management tool '
                'for Mercurial and Git with a built in push/pull server, '
                'full text search and code-review.')
 
 keywords = ' '.join([
     'kallithea', 'mercurial', 'git', 'code review',
     'repo groups', 'ldap', 'repository management', 'hgweb replacement',
     'hgwebdir', 'gitweb replacement', 'serving hgweb',
 ])
 
 # long description
 README_FILE = 'README.rst'
 CHANGELOG_FILE = 'docs/changelog.rst'
 try:
     long_description = open(README_FILE).read() + '\n\n' + \
         open(CHANGELOG_FILE).read()
 
 except IOError as err:
     sys.stderr.write(
         "[WARNING] Cannot find file specified as long_description (%s)\n or "
         "changelog (%s) skipping that file" % (README_FILE, CHANGELOG_FILE)
     )
     long_description = description
 
 try:
     from setuptools import setup, find_packages
 except ImportError:
     from ez_setup import use_setuptools
     use_setuptools()
     from setuptools import setup, find_packages
 
 # monkey patch setuptools to use distutils owner/group functionality
 from setuptools.command import sdist
 sdist_org = sdist.sdist
 class sdist_new(sdist_org):
     def initialize_options(self):
         sdist_org.initialize_options(self)
         self.owner = self.group = 'root'
 sdist.sdist = sdist_new
 
 # packages
 packages = find_packages(exclude=['ez_setup'])
 
 setup(
     name='Kallithea',
     version=__version__,
     description=description,
     long_description=long_description,
     keywords=keywords,
     license=__license__,
     author=__author__,
     author_email='[e-mail]',
     dependency_links=dependency_links,
     url=__url__,
     install_requires=requirements,
     classifiers=classifiers,
     setup_requires=["PasteScript>=1.6.3"],
     data_files=data_files,
     packages=packages,
     include_package_data=True,
     test_suite='nose.collector',
     package_data=package_data,
     message_extractors={'kallithea': [
             ('**.py', 'python', None),
             ('templates/**.mako', 'mako', {'input_encoding': 'utf-8'}),
             ('templates/**.html', 'mako', {'input_encoding': 'utf-8'}),
             ('public/**', 'ignore', None)]},
     zip_safe=False,
     paster_plugins=['PasteScript', 'Pylons'],
     entry_points="""
     [console_scripts]
     kallithea-api =    kallithea.bin.kallithea_api:main
     kallithea-gist =   kallithea.bin.kallithea_gist:main
     kallithea-config = kallithea.bin.kallithea_config:main
 
     [paste.app_factory]
     main = kallithea.config.middleware:make_app
 
     [paste.app_install]
     main = pylons.util:PylonsInstaller
 
     [paste.global_paster_command]
     setup-db=kallithea.lib.paster_commands.setup_db:Command
     cleanup-repos=kallithea.lib.paster_commands.cleanup:Command
     update-repoinfo=kallithea.lib.paster_commands.update_repoinfo:Command
     make-rcext=kallithea.lib.paster_commands.make_rcextensions:Command
     repo-scan=kallithea.lib.paster_commands.repo_scan:Command
     cache-keys=kallithea.lib.paster_commands.cache_keys:Command
     ishell=kallithea.lib.paster_commands.ishell:Command
     make-index=kallithea.lib.paster_commands.make_index:Command
     upgrade-db=kallithea.lib.dbmigrate:UpgradeDb
     celeryd=kallithea.lib.celerypylons.commands:CeleryDaemonCommand
     install-iis=kallithea.lib.paster_commands.install_iis:Command
 
     [nose.plugins]
     pylons = pylons.test:PylonsPlugin
     """,
 )