Installation

------------

virtualenv. Official releases of Kallithea can be installed with::

    pip install kallithea

.. _Custom CA Certificates:

Custom CA Certificates : optional

    It can be set to something like `/etc/openldap/cacerts` on older systems or

    if using self-signed certificates.

and the test suite creates repositories in the temporary directory. Linux

systems with /tmp mounted noexec will thus fail.

When running tests, Kallithea generates a `test.ini` based on template values

in `kallithea/tests/conftest.py` and populates the SQLite database specified

consistency with existing code. Run ``scripts/run-all-cleanup`` before

committing to ensure some basic code formatting consistency.

We try to support the most common modern web browsers. IE9 is still supported

to the extent it is feasible, IE8 is not.

For Debian and Ubuntu, the following command will ensure that a reasonable

set of dependencies is installed::

For Fedora and RHEL-derivatives, the following command will ensure that a

reasonable set of dependencies is installed::

.. _installation-source:

        . ../kallithea-venv/bin/activate

        pip install --upgrade pip setuptools

        pip install --upgrade -e .

You can now proceed to :ref:`setup`.

.. _installation_iis:

=====================================================================

Installing Kallithea on Microsoft Internet Information Services (IIS)

=====================================================================

has been generated, it is necessary to run the following command due to the way

that ISAPI-WSGI is made::

This accomplishes two things: generating an ISAPI compliant DLL file,

``_dispatch.dll``, and installing a script map handler into IIS for the

In order to dump output from WSGI using ``win32traceutil`` it is sufficient to

type the following in a console window::

and any exceptions occurring in the WSGI layer and below (i.e. in the Kallithea

application itself) that are uncaught, will be printed here complete with stack

.. _installation_win:

====================================================

Installation on Windows (7/Server 2008 R2 and newer)

====================================================

Step 1 -- Install Python

^^^^^^^^^^^^^^^^^^^^^^^^

- 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.

Remember the specific major and minor versions installed, because they will

Step 2 -- Python BIN

^^^^^^^^^^^^^^^^^^^^

  SETX PATH "%PATH%;[your-python-path]" /M

Please substitute [your-python-path] with your Python installation

Step 3 -- Install pywin32 extensions

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Click on "pywin32" folder

- Click on the first folder (in this case, Build 219, maybe newer when you try)

  for Win32) where x is the minor version of Python you installed.

  When writing this guide, the file was:

  (x64)

  (Win32)

Step 5 -- Kallithea folder structure

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.

.. 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.

.. _installation_win_old:

==========================================================

Installation on Windows (XP/Vista/Server 2003/Server 2008)

==========================================================

Step 2 -- Install Python

^^^^^^^^^^^^^^^^^^^^^^^^

http://www.python.org/download/

Remember the specific major and minor version installed, because it will

.. note::

http://sourceforge.net/projects/pywin32/files/

- Click on "pywin32" folder

  version of Python you installed (in this case, 7)

  When writing this guide, the file was:

  .. note::

     64-bit: Download and install the 64-bit version.

     At the time of writing you can find this at:

Step 4 -- Python BIN

^^^^^^^^^^^^^^^^^^^^

    SETX PATH "%PATH%;[your-python-path]" /M

  Please substitute [your-python-path] with your Python installation path.

Step 5 -- Kallithea folder structure

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

------------------

**Kallithea** is written entirely in Python_ and requires Python version

Given a Python installation, there are different ways of providing the

environment for running Python applications. Each of them pretty much

  installed with all dependencies using ``pip install kallithea``.

  With this method, Kallithea is installed in the Python environment as any

  directory with Python files and everything else that is needed.

  (``pip install kallithea`` from a source tree will do pretty much the same

      os.chdir('/srv/kallithea/')

      import site

      ini = '/srv/kallithea/my.ini'

      from logging.config import fileConfig

:A: Make sure either to set the ``static_files = true`` in the .ini file or

   double check the root path for your http setup. It should point to

   for example:

|

First update the translation strings::

setup.py update_catalog` or with `msgmerge` from the `gettext` package. As

Weblate is also touching these translation files, it is preferred to use the

same tools (`msgmerge`) and settings as Weblate to minimize the diff::

In the prepared development environment, run the following to ensure

all translation strings are extracted and up-to-date::

Create new language by executing following command::

This creates a new translation under directory `kallithea/i18n/<new_language_code>`

based on the translation template file, `kallithea/i18n/kallithea.pot`.

Finally, compile the translations::

Manually updating translations

Extract the latest versions of strings for translation by running::

Update the PO file by doing::

Edit the newly updated translation file. Repeat all steps after the

`init_catalog` step from the 'new translation' instructions above.

            if len(t) > ccm:

                kr.clear()

                kr.wait(2)

                    raise IOError(

                        "Timed out while waiting for input from subprocess.")

            t.append(b)

def main():

    filenames = subprocess.check_output(['hg', 'loc', 'set:**.rst+kallithea/i18n/how_to']).splitlines()

    for fn in filenames:

        print('processing %s' % fn)

        s = open(fn).read()

pip install --upgrade pip setuptools

pip install -e . -r "$min_requirements" python-ldap python-pam 2> >(tee "$log" >&2)

# Treat any message on stderr as a problem, for the caller to interpret.

if [ -s "$log" ]; then

    echo

from setuptools.command import sdist

if sys.version_info < (3, 6):

    raise Exception('Kallithea requires Python 3.6 or later')

    'Intended Audience :: Developers',

    'License :: OSI Approved :: GNU General Public License (GPL)',

    'Operating System :: OS Independent',

    'Topic :: Software Development :: Version Control',

]