^build

^dist/

^docs/build/

^docs/_build/

^data$

^sql_dumps/

^\.settings$

^\.project$

^\.pydevproject$

^\.coverage$

^kallithea\.db$

^test\.db$

^rc.*\.ini$

^fabfile.py

^\.idea$

    Marcin Kuźmiński <marcin@python-works.com>

    Lukasz Balcerzak <lukaszbalcerzak@gmail.com>

    Jason Harris <jason@jasonfharris.com>

    Thayne Harbaugh  <thayne@fusionio.com>

    cejones <>

    Thomas Waldmann <tw-public@gmx.de>

    Lorenzo M. Catucci <lorenzo@sancho.ccd.uniroma2.it>

    Dmitri Kuznetsov <>

    Jared Bunting <jared.bunting@peachjean.com>

    Steve Romanow <slestak989@gmail.com>

    Augosto Hermann <augusto.herrmann@planejamento.gov.br>    

    Ankit Solanki <ankit.solanki@gmail.com>    

    Philip Jameson <philip.j@hostdime.com>

    Mads Kiilerich <madski@unity3d.com>

    Dan Sheridan <djs@adelard.com>

    Dennis Brakhane <brakhane@googlemail.com>

    Simon Lopez <simon.lopez@slopez.org>

    Jonathan Sternberg <jonathansternberg@gmail.com>

    Grzegorz Rożniecki <xaerxess@gmail.com>

    Andrew Kesterson <andrew@aklabs.net>

    David A. Sjøen <david.sjoen@westcon.no>

    Jelmer Vernooij <jelmer@samba.org>

    larikale

    SteveCohen

    Sebastian Kreutzberger <sebastian@rhodecode.com>

    thomas <thomas@rhodecode.com>

=========

=========

About

-----

with a built in push/pull server, full text search and code-review.

It works on http/https and has a built in permission/authentication system with

simple API so it's easy integrable with existing external systems.

It is open source and donation ware and focuses more on providing a customized,

self administered interface for Mercurial_ and GIT_  repositories.

that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple

different version control systems.

Installation

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

    easy_install kallithea

Or::

    pip install kallithea

Detailed instructions and links may be found on the Installation page.

Please visit http://packages.python.org/Kallithea/installation.html for

more details

The latest sources can be obtained from https://kallithea-scm.org/repos/kallithea

MIRRORS:

Issue tracker and sources at bitbucket_

https://bitbucket.org/conservancy/kallithea

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

- Has its own middleware to handle mercurial_ and git_ protocol requests.

  Each request is authenticated and logged together with IP address.

- Build for speed and performance. You can make multiple pulls/pushes simultaneous.

  Proven to work with 1000s of repositories and users

- Supports http/https, LDAP, AD, proxy-pass authentication.

- Full permissions (private/read/write/admin) together with IP restrictions for each repository,

  additional explicit forking, repositories group and repository creation permissions.

- User groups for easier permission management.

- Repository groups let you group repos and manage them easier. They come with

  permission delegation features, so you can delegate groups management.

- Users can fork other users repos, and compare them at any time.

- Built in Gist functionality for sharing code snippets.

- Integrates easily with other systems, with custom created mappers you can connect it to almost

  any issue tracker, and with an JSON-RPC API you can make much more

  web interface using simple editor or upload binary files using simple form.

- Powerfull pull-request driven review system with inline commenting,

  changeset statuses, and notification system.

- Importing and syncing repositories from remote locations for GIT_, Mercurial_ and  SVN.

- Mako templates let's you customize the look and feel of the application.

- Beautiful diffs, annotations and source code browsing all colored by pygments.

  Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches

- Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics

  to track activity for repositories

- Admin interface with user/permission management. Admin activity journal, logs

  pulls, pushes, forks, registrations and other actions made by all users.

- Server side forks. It is possible to fork a project and modify it freely

- Web based merges for pull requests

- Tracking history for each lines in files

- Simple issue tracker

- SSH based authentication with server side key management

- Commit based built in wiki system

- More statistics and graph (global annotation + some more statistics)

- Other advancements as development continues (or you can of course make

  additions and or requests)

License

-------

Getting help

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

Listed bellow are various support resources that should help.

.. note::

   Please try to read the documentation before posting any issues, especially

   the **troubleshooting section**

- Open an issue at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_

- Join #kallithea on FreeNode (irc.freenode.net)

  or use http://webchat.freenode.net/?channels=kallithea for web access to irc.

You can follow this project on Twitter, **@KallitheaSCM**.

Online documentation

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

 - http://packages.python.org/Kallithea/

 - http://kallithea.readthedocs.org/

You may also build the documentation for yourself - go into ``docs/`` and run::

   make html

(You need to have sphinx_ installed to build the documentation. If you don't

have sphinx_ installed you can install it via the command:

``easy_install sphinx``)

.. _virtualenv: http://pypi.python.org/pypi/virtualenv

################################################################################

################################################################################

#                                                                              #

# The %(here)s variable will be replaced with the parent directory of this file#

################################################################################

[DEFAULT]

debug = true

pdebug = false

################################################################################

## Uncomment and replace with the address which should receive                ##

## any error reports after application crash                                  ##

################################################################################

#email_to = admin@localhost

#error_email_from = paste_error@localhost

#app_email_from = kallithea-noreply@localhost

#error_message =

#smtp_server = mail.server.com

#smtp_username =

#smtp_password =

#smtp_port =

#smtp_use_tls = false

#smtp_use_ssl = true

## Specify available auth parameters here (e.g. LOGIN PLAIN CRAM-MD5, etc.)

#smtp_auth =

[server:main]

## PASTE ##

## uncomment and set this path to use archive download cache

#archive_cache_dir = /tmp/tarballcache

## change this to unique ID for security

app_instance_uuid = rc-production

## cut off limit for large diffs (size in bytes)

cut_off_limit = 256000

## use cache version of scm repo everywhere

vcs_full_cache = true

force_https = false

## use Strict-Transport-Security headers

use_htsts = false

## number of commits stats will parse on each iteration

commit_parse_limit = 25

## use gravatar service to display avatars

use_gravatar = true

## path to git executable

## RSS feed options

rss_cut_off_limit = 256000

rss_items_per_page = 10

rss_include_diff = false

## options for showing and identifying changesets

show_sha_length = 12

show_revision_number = true

## gist URL alias, used to create nicer urls for gist. This should be an

## url that does rewrites to _admin/gists/<gistid>.

## example: http://gist.kallithea.server/{gistid}. Empty means use the internal

gist_alias_url =

## white list of API enabled controllers. This allows to add list of

## controllers to which access will be enabled by api_key. eg: to enable

## api access to raw_files put `FilesController:raw`, to enable access to patches

## add `ChangesetController:changeset_patch`. This list should be "," separated

## Syntax is <ControllerClass>:<function>. Check debug logs for generated names

## Recommended settings bellow are commented out:

api_access_controllers_whitelist =

#    ChangesetController:changeset_patch,

#    ChangesetController:changeset_raw,

#    FilesController:raw,

#    FilesController:archivefile

## alternative_gravatar_url allows you to use your own avatar server application

## the following parts of the URL will be replaced

## {email}        user email

## {md5email}     md5 hash of the user email (like at gravatar.com)

## {size}         size of the image that is expected from the server application

#alternative_gravatar_url = http://myavatarserver.com/getbyemail/{email}/{size}

#alternative_gravatar_url = http://myavatarserver.com/getbymd5/{md5email}?s={size}

## container auth options

container_auth_enabled = false

proxypass_auth_enabled = false

## default encoding used to convert from and to unicode

## can be also a comma seperated list of encoding in case of mixed encodings

default_encoding = utf8

## overwrite schema of clone url

## available vars:

## scheme - http/https

## user - current user

## pass - password

## netloc - network location

## path - usually repo_name

#clone_uri = {scheme}://{user}{pass}{netloc}{path}

#bugtracker = https://bitbucket.org/conservancy/kallithea/issues

## issue tracking mapping for commits messages

## comment out issue_pat, issue_server, issue_prefix to enable

## pattern to get the issues from commit messages

## default one used here is #<numbers> with a regex passive group for `#`

## {id} will be all groups matched from this pattern

issue_pat = (?:\s*#)(\d+)

## server url to the issue, each {id} will be replaced with match

## default cookie expiration time in seconds `true` expire at browser close ##

#beaker.session.cookie_expires = 3600

############################

## ERROR HANDLING SYSTEMS ##

############################

####################

### [errormator] ###

####################

## http://errormator.com for details how to obtain an account

## you must install python package `errormator_client` to make it work

## errormator enabled

errormator = false

errormator.server_url = https://api.errormator.com

errormator.api_key = YOUR_API_KEY

## TWEAK AMOUNT OF INFO SENT HERE

## enables 404 error logging (default False)

# celeryd - run the celeryd daemon as an upstart job for kallithea

# Change variables/paths as necessary and place file /etc/init/celeryd.conf

# start/stop/restart as normal upstart job (ie: $ start celeryd)

author		"Matt Zuba <matt.zuba@goodwillaz.org"

start on starting kallithea

stop on stopped kallithea

respawn

umask 0022

env PIDFILE=/tmp/celeryd.pid

env APPINI=/var/hg/kallithea/production.ini

env HOME=/var/hg

#!/bin/sh

########################################

#### THIS IS A REDHAT INIT.D SCRIPT ####

########################################

##################################################

#

# Recommended default-startup: 2 3 4 5

# Recommended default-stop: 0 1 6

#

##################################################

APP_NAME="kallithea"

# the location of your app

# since this is a web app, it should go in /var/www

APP_PATH="/var/www/$APP_NAME"

CONF_NAME="production.ini"

# write to wherever the PID should be stored, just ensure

# that the user you run paster as has the appropriate permissions

# same goes for the log file

PID_PATH="/var/run/kallithea/pid"

LOG_PATH="/var/log/kallithea/kallithea.log"

# replace this with the path to the virtual environment you

PYTHON_PATH="/opt/python_virtualenvironments/kallithea-venv"

RUN_AS="kallithea"

DAEMON="$PYTHON_PATH/bin/paster"

DAEMON_OPTS="serve --daemon \

    --user=$RUN_AS \

    --group=$RUN_AS \

    --pid-file=$PID_PATH \

    --log-file=$LOG_PATH $APP_PATH/$CONF_NAME"

    start_kallithea

    echo

    ;;

  stop)

    echo -n $"Stopping $DESC: "

    stop_kallithea

    echo

    ;;

  status)

    status_kallithea

    RETVAL=$?

    if [ ! $RETVAL -eq 0 ]; then

    else

    fi

    ;;

  restart)

    echo -n $"Restarting $DESC: "

    restart_kallithea

    echo

    ;;

  *)

    echo $"Usage: $0 {start|stop|restart|status}"

    RETVAL=1

    ;;

esac

# kallithea - run the kallithea daemon as an upstart job

# Change variables/paths as necessary and place file /etc/init/kallithea.conf

# start/stop/restart as normal upstart job (ie: $ start kallithea)

author		"Matt Zuba <matt.zuba@goodwillaz.org"

start on (local-filesystems and runlevel [2345])

stop on runlevel [!2345]

respawn

umask 0022

env PIDFILE=/var/hg/kallithea/kallithea.pid

env LOGFILE=/var/hg/kallithea/log/kallithea.log

env APPINI=/var/hg/kallithea/production.ini

; ##########################

; for help see http://supervisord.org/configuration.html

; ##########################

[inet_http_server]         ; inet (TCP) server disabled by default

port=127.0.0.1:9001        ; (ip_address:port specifier, *:port for all iface)

;username=user              ; (default is no username (open server))

;password=123               ; (default is no password (open server))

[supervisord]

logfile=/%(here)s/supervisord_kallithea.log ; (main log file;default $CWD/supervisord.log)

logfile_maxbytes=50MB        ; (max main logfile bytes b4 rotation;default 50MB)

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

kallithea.__init__

~~~~~~~~~~~~~~~~~~

versioning implementation: http://www.python.org/dev/peps/pep-0386/

This file was forked by the Kallithea project in July 2014.

Original author and date, and relevant copyright and licensing information is below:

:created_on: Apr 9, 2010

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

import sys

import platform

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

kallithea.bin.__init__

~~~~~~~~~~~~~~~~~~~~~~

This file was forked by the Kallithea project in July 2014.

Original author and date, and relevant copyright and licensing information is below:

:created_on: Jun 03, 2012

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

    try:

        import simplejson as json

    except ImportError:

        import json

CONFIG_NAME = '.config/kallithea'

FORMAT_PRETTY = 'pretty'

FORMAT_JSON = 'json'

def api_call(apikey, apihost, method=None, **kw):

    """

    :param apikey:

    :param apihost:

    :param format: formatting, pretty means prints and pprint of json

     json returns unparsed json

    :param method:

    :returns: json response from server

    """

    def _build_data(random_id):

        """

        Builds API data with given random ID

    if id_ret == id_:

        return json_data

    else:

        _formatted_json = pprint.pformat(json_data)

        raise Exception('something went wrong. '

                        'ID mismatch got %s, expected %s | %s' % (

                                            id_ret, id_, _formatted_json))

class RcConf(object):

    """

    conf = RcConf()

    conf['key']

    """

    def __init__(self, config_location=None, autoload=True, autocreate=False,

                 config=None):

        HOME = os.getenv('HOME', os.getenv('USERPROFILE')) or ''

        HOME_CONF = os.path.abspath(os.path.join(HOME, CONFIG_NAME))

        self._conf_name = HOME_CONF if not config_location else config_location

        self._conf = {}

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

kallithea.bin.api

~~~~~~~~~~~~~~~~~

This file was forked by the Kallithea project in July 2014.

Original author and date, and relevant copyright and licensing information is below:

:created_on: Jun 3, 2012

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

from __future__ import with_statement

import sys

import argparse

from kallithea.bin.base import json, api_call, RcConf, FORMAT_JSON, FORMAT_PRETTY

def argparser(argv):

    usage = (

      "kallithea-api [-h] [--format=FORMAT] [--apikey=APIKEY] [--apihost=APIHOST] "

      "[--config=CONFIG] [--save-config] "

      "METHOD <key:val> <key2:val> ...\n"

      "Create config file: kallithea-api --apikey=<key> --apihost=http://your.kallithea.server --save-config"

    )

                                     usage=usage)

    ## config

    group = parser.add_argument_group('config')

    group.add_argument('--apikey', help='api access key')

    group.add_argument('--apihost', help='api host')

    group.add_argument('--config', help='config file')

    group.add_argument('--save-config', action='store_true', help='save the given config into a file')

    group = parser.add_argument_group('API')

    group.add_argument('method', metavar='METHOD', nargs='?', type=str, default=None,

            help='API method name to call followed by key:value attributes',

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

kallithea.bin.kallithea_config

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This file was forked by the Kallithea project in July 2014.

Original author and date, and relevant copyright and licensing information is below:

:created_on: Jun 18, 2013

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

from __future__ import with_statement

import os

TMPL = 'template.ini.mako'

here = os.path.dirname(os.path.abspath(__file__))

def argparser(argv):

    usage = (

      "kallithea-config [-h] [--filename=FILENAME] [--template=TEMPLATE] \n"

      "VARS optional specify extra template variable that will be available in "

      "template. Use comma separated key=val format eg.\n"

      "key1=val1,port=5000,host=127.0.0.1,elements='a\,b\,c'\n"

    )

    parser = argparse.ArgumentParser(

        usage=usage

    )

    ## config

    group = parser.add_argument_group('CONFIG')

    group.add_argument('--filename', help='Output ini filename.')

    group.add_argument('--template', help='Mako template file to use instead of '

                                          'the default builtin template')

    group.add_argument('--raw', help='Store given mako template as raw without '

                                     'parsing. Use this to create custom template '

                                     'initially', action='store_true')

    group.add_argument('--show-defaults', help='Show all default variables for '

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""

kallithea.bin.kallithea_gist

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This file was forked by the Kallithea project in July 2014.

Original author and date, and relevant copyright and licensing information is below:

:created_on: May 9, 2013

:author: marcink

:copyright: (c) 2013 RhodeCode GmbH, and others.

:license: GPLv3, see LICENSE.md for more details.

"""

from __future__ import with_statement

import os

import sys

from kallithea.bin.base import json, api_call, RcConf, FORMAT_JSON, FORMAT_PRETTY

def argparser(argv):

    usage = (

      "kallithea-gist [-h] [--format=FORMAT] [--apikey=APIKEY] [--apihost=APIHOST] "

      "[--config=CONFIG] [--save-config] [GIST OPTIONS] "

      "[filename or stdin use - for terminal stdin ]\n"

      "Create config file: kallithea-gist --apikey=<key> --apihost=http://your.kallithea.server --save-config"

    )

                                     usage=usage)

    ## config

    group = parser.add_argument_group('config')

    group.add_argument('--apikey', help='api access key')

    group.add_argument('--apihost', help='api host')

    group.add_argument('--config', help='config file path DEFAULT: ~/.config/kallithea')

    group.add_argument('--save-config', action='store_true',

                       help='save the given config into a file')

    group = parser.add_argument_group('GIST')

    group.add_argument('-p', '--private', action='store_true',

        self.key = key

    def get_api_data(self, uid, method, args):

        """Prepare dict for API post."""

        return {

            "id": uid,

            "api_key": self.key,

            "method": method,

            "args": args

        }

    def post(self, method, args):

        This will generate the UUID for validation check after the

        response is returned. Handle errors and get the result back.

        """

        uid = str(uuid.uuid1())

        data = self.get_api_data(uid, method, args)

        data = json.dumps(data)

        headers = {'content-type': 'text/plain'}

        req = urllib2.Request(self.url, data, headers)

        response = urllib2.urlopen(req)

        response = json.load(response)

        if uid != response["id"]:

            raise InvalidResponseIDError("UUID does not match.")

        if response["error"] is not None:

            raise ResponseError(response["error"])

        return response["result"]

    def create_group(self, name, active=True):