kallithea Changeset - 6f60bd9090b1

Changeset - 6f60bd9090b1

Parent rev.

Child rev.

[Not reviewed]

Merge stable

10 364 13

Mads Kiilerich - 10 years ago 2015-09-06 23:36:05
madski@unity3d.com

release: merge default to stable for 0.3

39 files changed:

.hgignore

.hgtags

CONTRIBUTORS

105

LICENSE.md

MANIFEST.in

README.rst

development.ini

docs/api/api.rst

docs/api/models.rst

docs/changelog.rst

docs/conf.py

docs/contributing.rst

docs/index.rst

docs/installation.rst

docs/installation_iis.rst

docs/installation_win.rst

docs/installation_win_old.rst

docs/overview.rst

141

docs/setup.rst

110

docs/theme/nature/layout.html

docs/theme/nature/static/nature.css_t

docs/usage/backup.rst

docs/usage/debugging.rst

docs/usage/email.rst

docs/usage/general.rst

docs/usage/locking.rst

docs/usage/performance.rst

docs/usage/statistics.rst

docs/usage/troubleshooting.rst

docs/usage/vcs_support.rst

init.d/kallithea-daemon-arch

+chmod

init.d/kallithea-daemon-redhat

+chmod

kallithea/__init__.py

kallithea/bin/__init__.py

kallithea/bin/base.py

kallithea/bin/kallithea_api.py

kallithea/bin/kallithea_backup.py

kallithea/bin/kallithea_config.py

kallithea/bin/kallithea_gist.py

Changeset was too big and was cut off... Show full diff anyway

0 comments (0 inline, 0 general)

.hgignore

➞

Show inline comments

 syntax: glob
 *.pyc
 *.swp
 *.sqlite
 *.tox
 *.egg-info
 *.egg
 *.mo
 .eggs/
 tarballcache/
 syntax: regexp
 ^rcextensions
 ^build
 ^dist/
 ^docs/build/
 ^docs/_build/
 ^data$
 ^kallithea/tests/data$
 ^sql_dumps/
 ^\.settings$
 ^\.project$
 ^\.pydevproject$
 ^\.coverage$
 ^kallithea\.db$
 ^test\.db$
 ^Kallithea\.egg-info$
 ^my\.ini$
 ^fabfile.py
 ^\.idea$

.hgtags

➞

Show inline comments

 c097458480a5972dd75d5695b61e855fd0ab371e rhodecode-0.0.0.7.0
 bdec09436cb7e4a764bd2ba50b84060e30eb34f rhodecode-0.0.0.7.1
 a18994cdc3bdd156ee93c7c0fb8d94a88f1f640 rhodecode-0.0.0.7.2
 a3a7c3e03b76ee264a828cb1087970bb98bbffcd rhodecode-0.0.0.7.3
 b46f9194c347641bfc9a26697ef413a4761971 rhodecode-0.0.0.7.4
 e7a75bb6b8346cee3bd0ddda67592e4790268 rhodecode-0.0.0.7.5
 ca80f8c0056211dad33483a50b913593516d7a6c rhodecode-0.0.0.7.6
 cf49c29c846fefeb4e1a222e4b1850e9e3eaa62 rhodecode-0.0.0.7.7
 c7e565c56a49c89414e81f28571c8e5b67408 rhodecode-0.0.0.7.8
 c12f4d19c95065f313eefcd45eac9ef507f5fa55 rhodecode-0.0.0.7.9
 eb7c5028f24a90b5466ed16be13b213ba1fc2 rhodecode-0.0.0.8.0
 a9814a642e11092b243ca01721254a04633a0ffc rhodecode-0.0.0.8.1
 ccbe729908844884aea89d00fb14a6cb92e10c06 rhodecode-0.0.0.8.2
 ca41d544dbdfd2f81bd0304168492a26276aadb6 rhodecode-0.0.0.8.3
 fa16ec5822da0c6fade3dd1ed9b6c0655e5dbbf rhodecode-0.0.0.8.4
 ba57d8fe2317c49dbd422afd07ab497687aa02 rhodecode-0.0.0.8.5
 b6b9a4ddb6ee9554cbb83a082a6d1316b42 rhodecode-0.0.1.0.0rc4
 afd98d1f817e6a6b52172735c22160239e615a6b rhodecode-0.0.1.0.0
 bee56f209c40a6880f2f633b02227b5ee1f8ff5a rhodecode-0.0.1.0.1
 d85b0948e53925ebbbc49e9f7967013a04f866e9 rhodecode-0.0.1.0.2
 d9c8dddb96af521e346f05b88d515c536eef3d17 rhodecode-0.0.1.1.0
 f748517814ed0408a49e392dc625f4cc37fdc rhodecode-0.0.1.1.1
 c01c12eafb8cc72d4c4cbd121400fad755b2862 rhodecode-0.0.1.1.2
 fa80e0484ef5c33feaa9c39fc66916f410ba353 rhodecode-0.0.1.1.3
 cb77867d69d3c5931712aac486c980a42ee90745 rhodecode-0.0.1.1.5
 cb77867d69d3c5931712aac486c980a42ee90745 rhodecode-0.0.1.1.5
 bdfdd95c8bd31ae6d89f76c75c1f49cbcd0bc rhodecode-0.0.1.1.5
 c5af1d3c861fb36b156224e75c2f55a97f54657d rhodecode-0.0.1.1.6
 a0d1584cf28d33e738048af1f6809d499451 rhodecode-0.0.1.1.7
 bd102f45950f779995a1beae42b6eb099cdd27b3 rhodecode-0.0.1.1.7
 c8974135732aa0ceb841cee6df66e29f089b4963 rhodecode-0.0.1.1.8
 c252049af24cd98eef5f4143fa3abbff3c912e29 rhodecode-0.0.1.2.0
 b8fba8ab90b01f811a50e6e7384989cced21d38 rhodecode-0.0.1.2.1
 bec00ba2fd860c60a9277d3d7229e288e18 rhodecode-0.0.1.2.2
 ff606a7858dbd8a5f70b3da5cc89524bd0d84f9 rhodecode-0.0.1.2.3
 a7a282a902b207ce34e830d643c79b7ab52e3b35 rhodecode-0.0.1.2.4
 b6b611e7722e754abebaae6e265cbb4c823d344d rhodecode-0.0.1.2.5
 dbc82e3362a25d2aece42060089824c4342efd17 rhodecode-0.0.1.3.0
 a95f338fd0115b2cdb77118f39e17d22ff505c rhodecode-0.0.1.3.1
 ab21c5ddb84935bea5c743b4e147ed5a398b30c rhodecode-0.0.1.3.2
 f028b582a254e0028ba25e5d20dd32b9cd rhodecode-0.0.1.3.3
 af21362474e3ab5aa0e2fbb1c872356f2c16c4f3 rhodecode-0.0.1.3.4
 e2792e04bd316fe64335cbe6a476031ac60b29b rhodecode-0.0.1.3.5
 edfff9f37916389144d3a3644d0a7d7adfd79b11 rhodecode-0.0.1.3.6
 ae95fdeca184f2404205645f06c6597b74ef2db rhodecode-0.0.1.4.0
 a4dde53c46d4f24abb426ec870471c7de1 rhodecode-0.0.1.4.1
 d998cc84cf726798486a438763053f0e1dc1b646 rhodecode-0.0.1.4.2
 f5d40b9dd99ccb009ea2211ee2d4b594c634946 rhodecode-0.0.1.4.3
 c08cf86f1849917e2d50f7ab7766c1550b0a rhodecode-0.0.1.4.4
 a5f0bc867edc88be23eb808693e5393a97d4c54a rhodecode-0.0.1.5.0
 dc7caea48687eab018ee646ae6ad7e7ef377 rhodecode-0.0.1.5.1
 efe23d6c178c11d575a0214181276a3452776e48 rhodecode-0.0.1.5.2
 a498b11f1540f5b94b6f6009298f5dc3eaad9e9 rhodecode-0.0.1.5.3
 3447862ad8c9ceba85857774c526e39fde3a2281 rhodecode-0.0.1.5.4
 c15d7b336af58df9f1bbc8f8957464e7ea618d4c rhodecode-0.0.1.6.0rc1
 b53ee0d247f90d51b028307ff5717851b6c265 rhodecode-0.0.1.6.0
 ad34d56321349ff5bd38f537bd768b8efef2e rhodecode-0.0.1.7.0
 f71ef689d2a3c9978cea6591a1f4e9107a5ca83 rhodecode-0.0.1.7.1
 cc48c1541c7e2e84114bf92a0f9cd4b8b1341545 0.0
 d17e88a1a88a29f6fac948c94498129e405a40d3 0.1
 ad0ce803b40cb17fc3988373052943e041030b02 0.2
 c6e32714336345403adf76abb6ebf9b8116fcdc7 0.2.1
 f488a5dc4ca6647bc6acf12534fd137e968aa8 0.2.2

CONTRIBUTORS

➞

Show inline comments

 List of contributors to Kallithea project:
     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>
     Liad Shani <liadff@gmail.com>
     Les Peabody <lpeabody@gmail.com>
     Mads Kiilerich <madski@unity3d.com> 2012-2015
     Takumi IINO <trot.thunder@gmail.com> 2012-2015
     Unity Technologies 2012-2015
     Andrew Shadura <andrew@shadura.me> 2012 2014-2015
     Aras Pranckevičius <aras@unity3d.com> 2012-2013 2015
     Sean Farley <sean.michael.farley@gmail.com> 2013-2015
     Christian Oyarzun <oyarzun@gmail.com> 2014-2015
     Joseph Rivera <rivera.d.joseph@gmail.com> 2014-2015
     Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> 2014-2015
     Anatoly Bubenkov <bubenkoff@gmail.com> 2015
     Andrew Bartlett <abartlet@catalyst.net.nz> 2015
     Balázs Úr <urbalazs@gmail.com> 2015
     Ben Finney <ben@benfinney.id.au> 2015
     Branko Majic <branko@majic.rs> 2015
     Daniel Hobley <danielh@unity3d.com> 2015
     David Avigni <david.avigni@ankapi.com> 2015
     Denis Blanchette <dblanchette@coveo.com> 2015
     duanhongyi <duanhongyi@doopai.com> 2015
     EriCSN Chang <ericsning@gmail.com> 2015
     Étienne Gilli <etienne.gilli@gmail.com> 2015
     Grzegorz Krason <grzegorz.krason@gmail.com> 2015
     Jan Heylen <heyleke@gmail.com> 2015
     Kazunari Kobayashi <kobanari@nifty.com> 2015
     Kevin Bullock <kbullock@ringworld.org> 2015
     kobanari <kobanari@nifty.com> 2015
     Marc Abramowitz <marc@marc-abramowitz.com> 2015
     Marc Villetard <marc.villetard@gmail.com> 2015
     Matthias Zilk <matthias.zilk@gmail.com> 2015
     Michael Pohl <michael@mipapo.de> 2015
     Michael V. DePalatis <mike@depalatis.net> 2015
     Morten Skaaning <mortens@unity3d.com> 2015
     Nick High <nick@silverchip.org> 2015
     Niemand Jedermann <predatorix@web.de> 2015
     Peter Vitt <petervitt@web.de> 2015
     Robert Martinez <ntttq@inboxen.org> 2015
     Ronny Pfannschmidt <opensource@ronnypfannschmidt.de> 2015
     Sam Jaques <sam.jaques@me.com> 2015
     Søren Løvborg <sorenl@unity3d.com> 2015
     Tuux <tuxa@galaxie.eu.org> 2015
     Viktar Palstsiuk <vipals@gmail.com> 2015
     Dominik Ruf <dominikruf@gmail.com> 2012 2014
     Bradley M. Kuhn <bkuhn@sfconservancy.org> 2014
     Calinou <calinou@opmbx.org> 2014
     Daniel Anderson <daniel@dattrix.com> 2014
     Henrik Stuart <hg@hstuart.dk> 2014
     Ingo von Borstel <kallithea@planetmaker.de> 2014
     Jelmer Vernooĳ <jelmer@samba.org> 2014
     Jim Hague <jim.hague@acm.org> 2014
     Matt Fellows <kallithea@matt-fellows.me.uk> 2014
     Max Roman <max@choloclos.se> 2014
     Michal Čihař <michal@cihar.com> 2014
     Na'Tosha Bard <natosha@unity3d.com> 2014
     Rasmus Selsmark <rasmuss@unity3d.com> 2014
     Tim Freund <tim@freunds.net> 2014
     Travis Burtrum <android@moparisthebest.com> 2014
     Zoltan Gyarmati <mr.zoltan.gyarmati@gmail.com> 2014
     Marcin Kuźmiński <marcin@python-works.com> 2010-2013
     xpol <xpolife@gmail.com> 2012-2013
     Aparkar <aparkar@icloud.com> 2013
     Dennis Brakhane <brakhane@googlemail.com> 2013
     Grzegorz Rożniecki <xaerxess@gmail.com> 2013
     Jonathan Sternberg <jonathansternberg@gmail.com> 2013
     Leonardo Carneiro <leonardo@unity3d.com> 2013
     Magnus Ericmats <magnus.ericmats@gmail.com> 2013
     Martin Vium <martinv@unity3d.com> 2013
     Simon Lopez <simon.lopez@slopez.org> 2013
     Ton Plomp <tcplomp@gmail.com> 2013
     Augusto Herrmann <augusto.herrmann@planejamento.gov.br> 2011-2012
     Dan Sheridan <djs@adelard.com> 2012
     Dies Koper <diesk@fast.au.fujitsu.com> 2012
     Erwin Kroon <e.kroon@smartmetersolutions.nl> 2012
     H Waldo G <gwaldo@gmail.com> 2012
     hppj <hppj@postmage.biz> 2012
     Indra Talip <indra.talip@gmail.com> 2012
     mikespook 2012
     nansenat16 <nansenat16@null.tw> 2012
     Philip Jameson <philip.j@hostdime.com> 2012
     Raoul Thill <raoul.thill@gmail.com> 2012
     Stefan Engel <mail@engel-stefan.de> 2012
     Tony Bussieres <t.bussieres@gmail.com> 2012
     Vincent Caron <vcaron@bearstech.com> 2012
     Vincent Duvert <vincent@duvert.net> 2012
     Vladislav Poluhin <nuklea@gmail.com> 2012
     Zachary Auclair <zach101@gmail.com> 2012
     Ankit Solanki <ankit.solanki@gmail.com> 2011
     Dmitri Kuznetsov 2011
     Jared Bunting <jared.bunting@peachjean.com> 2011
     Jason Harris <jason@jasonfharris.com> 2011
     Les Peabody <lpeabody@gmail.com> 2011
     Liad Shani <liadff@gmail.com> 2011
     Lorenzo M. Catucci <lorenzo@sancho.ccd.uniroma2.it> 2011
     Matt Zuba <matt.zuba@goodwillaz.org> 2011
     Nicolas VINOT <aeris@imirhil.fr> 2011
     Shawn K. O'Shea <shawn@eth0.net> 2011
     Thayne Harbaugh <thayne@fusionio.com> 2011
     Łukasz Balcerzak <lukaszbalcerzak@gmail.com> 2010
     Andrew Kesterson <andrew@aklabs.net>
     cejones
     David A. Sjøen <david.sjoen@westcon.no>
     James Rhodes <jrhodes@redpointsoftware.com.au>
     Jonas Oberschweiber <jonas.oberschweiber@d-velop.de>
     Matt Zuba <matt.zuba@goodwillaz.org>
     Aras Pranckevicius <aras@unity3d.com>
     Tony Bussieres <t.bussieres@gmail.com>
     Erwin Kroon <e.kroon@smartmetersolutions.nl>
     nansenat16 <nansenat16@null.tw>
     Vincent Duvert <vincent@duvert.net>
     Takumi IINO <trot.thunder@gmail.com>
     Indra Talip <indra.talip@gmail.com>
     James Rhodes <jrhodes@redpointsoftware.com.au>
     Dominik Ruf <dominikruf@gmail.com>
     xpol <xpolife@gmail.com>
     Vincent Caron <vcaron@bearstech.com>
     Zachary Auclair <zach101@gmail.com>
     Stefan Engel <mail@engel-stefan.de>
     Andrew Shadura <andrew@shadura.me>
     Raoul Thill <raoul.thill@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 Vernooĳ <jelmer@samba.org>
     larikale
     SteveCohen
     RhodeCode GmbH
     Sebastian Kreutzberger <sebastian@rhodecode.com>
     thomas <thomas@rhodecode.com>
     Bradley M. Kuhn <bkuhn@sfconservancy.org>
     Sean Farley <sean.michael.farley@gmail.com>
     Martin Vium <martinv@unity3d.com>
     Daniel Anderson <daniel@dattrix.com>
     Travis Burtrum <android@moparisthebest.com>
     Calinou <calinou@opmbx.org>
     Christian Oyarzun <oyarzun@gmail.com>
     Denis Blanchette <dblanchette@coveo.com>
     duanhongyi <duanhongyi@doopai.com>
     Henrik Stuart <hg@hstuart.dk>
     Ingo von Borstel <kallithea@planetmaker.de>
     Jan Heylen <heyleke@gmail.com>
     Jim Hague <jim.hague@acm.org>
     Joseph Rivera <rivera.d.joseph@gmail.com>
     Kazunari Kobayashi <kobanari@nifty.com>
     Matt Fellows <kallithea@matt-fellows.me.uk>
     Max Roman <max@choloclos.se>
     Michael Pohl <michael@mipapo.de>
     Michael V. DePalatis <mike@depalatis.net>
     Michal Čihař <michal@cihar.com>
     Morten Skaaning <mortens@unity3d.com>
     Na'Tosha Bard <natosha@unity3d.com>
     Nick High <nick@silverchip.org>
     Niemand Jedermann <predatorix@web.de>
     Peter Vitt <petervitt@web.de>
     Sam Jaques <sam.jaques@me.com>
     Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
     Tuux <tuxa@galaxie.eu.org>
     Zoltan Gyarmati <mr.zoltan.gyarmati@gmail.com>
     Kevin Bullock <kbullock@ringworld.org>
     Marc Villetard <marc.villetard@gmail.com>
     Matthias Zilk <matthias.zilk@gmail.com>
     Tim Freund <tim@freunds.net>
     Steve Romanow <slestak989@gmail.com>
     SteveCohen
     Thomas <thomas@rhodecode.com>
     Thomas Waldmann <tw-public@gmx.de>

LICENSE.md

➞

Show inline comments

 Kallithea License
 =================
 Kallithea as a whole is copyrighted by various authors and is licensed under
 the terms of the GNU General Public License, version 3 (GPLv3), which is a
 license published by the Free Software Foundation,
 Inc. [A copy of GPLv3](/COPYING) is included herein.
 Some individual files have copyright notices and those who offer changes to
 those files should update the copyright notices in those specific files if
 they so chose.
 However, the definitive list of copyright holders for this project is kept in
 [the about page template](kallithea/templates/about.html) so that it is
 displayed appropriately when Kallithea is installed.  This is the most
-important place to update copyright notices.
 important place to update copyright notices.
 Third-Party Code Incorporated in Kallithea
 ==========================================
 Various third-party code under GPLv3-compatible licenses is included as part
 of Kallithea.
 Bootstrap
 ---------
 Kallithea incorporates parts of the Javascript system called
 [Bootstrap](http://getbootstrap.com/), which is:
 Copyright &copy; 2012 Twitter, Inc.
 and licensed under
 [the Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
 A copy of the Apache License 2.0 is also included in this distribution in its
 entirety in the file Apache-License-2.0.txt
 Codemirror
 ----------
 Kallithea incorporates parts of the Javascript system called
 [Codemirror](http://codemirror.net/), version 4.7.0, which is primarily:
 Copyright &copy; 2013-2014 by Marijn Haverbeke <marijnh@gmail.com>
 and licensed under the MIT-permissive license, which is
 [included in this distribution](MIT-Permissive-License.txt).
 Additional files from upstream Codemirror are copyrighted by various authors
 and licensed under other permissive licenses.  The sub-directories under
 [.../public/codemirror](kallithea/public/codemirror) include the copyright and
 license notice and information as they appeared in Codemirror's upstream
 release.
 jQuery
 ------
 Kallithea incorporates the Javascript system called
 [jQuery](http://jquery.org/),
 [herein](kallithea/public/js/jquery-1.11.1.min.js), and the Corresponding
 Source can be found in https://github.com/jquery/jquery at tag 1.11.1
 (mirrored at https://kallithea-scm.org/repos/mirror/jquery/files/1.11.1/ ).
 It is Copyright 2013 jQuery Foundation and other contributors http://jquery.com/ and is under an
 [MIT-permissive license](MIT-Permissive-License.txt).
 Mousetrap
 ---------
 Kallithea incorporates parts of the Javascript system called
 [Mousetrap](http://craig.is/killing/mice/), which is:
    Copyright 2013 Craig Campbell
 and licensed under
 [the Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
 A [copy of the Apache License 2.0](Apache-License-2.0.txt) is also included
 in this distribution.
 Mergely
 -------
 Kallithea incorporates some code from the Javascript system called
 [Mergely](http://www.mergely.com/), version 3.3.9.
 [Mergely's license](http://www.mergely.com/license.php), a
 [copy of which is included in this repository](LICENSE-MERGELY.html),
 is (GPL|LGPL|MPL).  Kallithea as GPLv3'd project chooses the GPL arm of that
 tri-license.
 Select2
 -------
 Kallithea incorporates parts of the Javascript system called
 [Select2](http://ivaynberg.github.io/select2/), which is:
 Copyright 2012 Igor Vaynberg (and probably others)
 and is licensed [under the following license](https://github.com/ivaynberg/select2/blob/master/LICENSE):
 > This software is licensed under the Apache License, Version 2.0 (the
 > "Apache License") or the GNU General Public License version 2 (the "GPL
 > License"). You may choose either license to govern your use of this
 > software only upon the condition that you accept all of the terms of either
 > the Apache License or the GPL License.
 A [copy of the Apache License 2.0](Apache-License-2.0.txt) is also included
 in this distribution.
 Kallithea will take the Apache license fork of the dual license, since
 Kallithea is GPLv3'd.
 Select2-Bootstrap-CSS
 ---------------------
 Kallithea incorporates some CSS from a system called
 [Select2-bootstrap-css](https://github.com/t0m/select2-bootstrap-css), which
 is:
 Copyright &copy; 2013 Tom Terrace (and likely others)
 and licensed under the MIT-permissive license, which is
 [included in this distribution](MIT-Permissive-License.txt).
 History.js
 ----------
 Kallithea incorporates some CSS from a system called History.js, which is
 Copyright 2010-2011 Benjamin Arthur Lupton <contact@balupton.com>
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 . Redistributions of source code must retain the above copyright notice,
    this list of conditions and the following disclaimer.
 . Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 YUI
 ---
 Kallithea incorporates parts of the Javascript system called
 [YUI 2 — Yahoo! User Interface Library](http://yui.github.io/yui2/docs/yui_2.9.0_full/),
 which is made available under the [BSD License](http://yuilibrary.com/license/):
 Copyright &copy; 2013 Yahoo! Inc. All rights reserved.
 Redistribution and use of this software in source and binary forms, with or
 without modification, are permitted provided that the following conditions are
 met:
 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of Yahoo! Inc. nor the names of YUI's contributors may be
   used to endorse or promote products derived from this software without
   specific prior written permission of Yahoo! Inc.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 Kallithea includes a minified version of YUI 2.9. To build yui.2.9.js:
     git clone https://github.com/yui/builder
     git clone https://github.com/yui/yui2
     cd yui2/
     git checkout hudson-yui2-2800
     ln -sf JumpToPageDropDown.js src/paginator/js/JumpToPageDropdown.js # work around inconsistent casing
     rm -f tmp.js
     for m in yahoo event dom connection animation dragdrop element datasource autocomplete container event-delegate json datatable paginator; do
       rm -f build/\$m/\$m.js
       ( cd src/\$m && ant build deploybuild ) && sed -e 's,@VERSION@,2.9.0,g' -e 's,@BUILD@,2800,g' build/\$m/\$m.js >> tmp.js
     done
     java -jar ../builder/componentbuild/lib/yuicompressor/yuicompressor-2.4.4.jar tmp.js -o yui.2.9.js
 In compliance with GPLv3 the Corresponding Source for this Object Code is made
 available on
 [https://kallithea-scm.org/repos/mirror](https://kallithea-scm.org/repos/mirror).
 Flot
 ----
 Kallithea incorporates some CSS from a system called
 [Flot](http://code.google.com/p/flot/), which is:
 Copyright 2006 Google Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 A [copy of the Apache License 2.0](Apache-License-2.0.txt) is also included
 in this distribution.
 Migrate
 -------
 Kallithea incorporates in kallithea/lib/dbmigrate/migrate parts of the Python
 system called [Migrate or sqlalchemy-migrate](https://github.com/stackforge/sqlalchemy-migrate),
 which is:
 Copyright (c) 2009 Evan Rosson, Jan Dittberner, Domen Kožar
 and licensed under the MIT-permissive license, which is
 [included in this distribution](MIT-Permissive-License.txt).
 Icon fonts
 ----------
 Kallithea incorporates subsets of both
 [Font Awesome](http://fontawesome.io) and
 [GitHub Octicons](https://octicons.github.com) for icons. Font Awesome is:
 Copyright (c) 2012, Dave Gandy
 Octicons is:
 Copyright (c) 2012-2014 GitHub
 These two sets are distributed under [SIL OFL 1.1](http://scripts.sil.org/OFL)
 and have been combined into one font called "kallithea."
 EOF

MANIFEST.in

➞

Show inline comments

@@ modified file chmod 100755 => 100644 @@
 include           Apache-License-2.0.txt
 include           CONTRIBUTORS
 include           COPYING
 include           LICENSE-MERGELY.html
 include           LICENSE.md
 include           MIT-Permissive-License.txt
 include           README.rst
 include           development.ini
 recursive-include docs *
 recursive-include init.d *
 include           kallithea/bin/ldap_sync.conf
 include           kallithea/bin/template.ini.mako
 include           kallithea/config/deployment.ini_tmpl
 recursive-include kallithea/i18n *
 recursive-include kallithea/lib/dbmigrate *.py_tmpl README migrate.cfg
 recursive-include kallithea/public *
 recursive-include kallithea/templates *
 recursive-include kallithea/tests/fixtures *
 recursive-include kallithea/tests/scripts *
 include           kallithea/tests/test.ini
 include           kallithea/tests/vcs/aconfig
 include           production.ini
 include           test.ini

README.rst

➞

Show inline comments

 ================
 Kallithea README
 ================
 About
 -----
 **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. It works on
 http/https and has a built in permission/authentication system with the ability
 to authenticate via LDAP or ActiveDirectory. Kallithea also provides simple API
 so it's easy to integrate with existing external systems.
 Kallithea is similar in some respects to GitHub_ or Bitbucket_, however
 Kallithea can be run as standalone hosted application on your own server. It is
 open-source donationware and focuses more on providing a customised,
 self-administered interface for Mercurial_ and Git_ repositories. Kallithea
 works on Unix-like systems and Windows, and is powered by the vcs_ library
 created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple
 version control systems.
 Kallithea was forked from RhodeCode in July 2014 and has been heavily modified.
 Installation
 ------------
 Official releases of Kallithea can be installed via::
 Kallithea requires Python_ 2.x and it is recommended to install it in a
 virtualenv_. Official releases of Kallithea can be installed with::
     pip install kallithea
 The development repository is kept very stable and used in production by the
 developers - you can do the same.
+developers -- you can do the same.
 Please visit https://docs.kallithea-scm.org/en/latest/installation.html for
 more details.
 Source code
 -----------
 The latest sources can be obtained from
 https://kallithea-scm.org/repos/kallithea.
 The issue tracker and a repository mirror can be found at Bitbucket_ on
 https://bitbucket.org/conservancy/kallithea.
 Kallithea Features
 Kallithea features
 ------------------
 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each
   request is authenticated and logged together with IP address.
 - Built for speed and performance. You can make multiple pulls/pushes
   simultaneously. Proven to work with thousands 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 versioned paste functionality (Gist) for sharing code snippets.
 - Integrates easily with other systems, with custom created mappers you can
   connect it to almost any issue tracker, and with a JSON-RPC API you can make
   much more.
 - Built-in commit API lets you add, edit and commit files right from Kallithea
   web interface using simple editor or upload binary files using simple form.
 - Powerful pull request driven review system with inline commenting, changeset
   statuses, and notification system.
 - Importing and syncing repositories from remote locations for Git_, Mercurial_
   and Subversion.
 - Mako templates let 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 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
   without breaking the main repository.
 - reST and Markdown README support for repositories.
 - Full text search powered by Whoosh on the source files, commit messages, and
   file names. Built-in indexing daemons, with optional incremental index build
   (no external search servers required all in one application).
 - Setup project descriptions/tags and info inside built in DB for easy,
   non-filesystem operations.
 - Intelligent cache with invalidation after push or project change, provides
   high performance and always up to date data.
 - RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz.
 - Optional async tasks for speed and performance using Celery_.
 - Backup scripts can do backup of whole app and send it over scp to desired
   location.
 - Based on Pylons, SQLAlchemy, SQLite, Whoosh, vcs.
 License
 -------
 **Kallithea** is released under the GPLv3 license. Kallithea is a `Software
 Freedom Conservancy`_ project and thus controlled by a non-profit organization.
 No commercial entity can take ownership of the project and change the
 direction.
 Kallithea started out as an effort to make sure the existing GPLv3 codebase
 would stay available under a legal license. Kallithea thus has to stay GPLv3
 compatible ... but we are also happy it is GPLv3 and happy to keep it that way.
 A different license (such as AGPL) could perhaps help attract a different
 community with a different mix of Free Software people and companies but we are
 happy with the current focus.
 Community
 ---------
 **Kallithea** is maintained by its users who contribute the fixes they would
- like to see.
 like to see.
 Get in touch with the rest of the community:
 - Join the mailing list users and developers - see
+- Join the mailing list users and developers -- see
   http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.
 - Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use
   http://webchat.freenode.net/?channels=kallithea.
 - Follow Kallithea on Twitter, **@KallitheaSCM**.
 - Issues can be reported at `issue tracker
   <https://bitbucket.org/conservancy/kallithea/issues>`_.
    .. note::
        Please try to read the documentation before posting any issues,
        especially the **troubleshooting section**
 Online documentation
 --------------------
 Online documentation for the current version of Kallithea is available at
 https://pythonhosted.org/Kallithea/. Documentation for the current development
 version can be found on https://docs.kallithea-scm.org/.
 You can also build the documentation locally: go to ``docs/`` and run::
    make html
 .. note:: You need to have Sphinx_ installed to build the
           documentation. If you don't have Sphinx_ installed you can
           install it via the command: ``pip install sphinx`` .
 Converting from RhodeCode
 -------------------------
 Currently, you have two options for working with an existing RhodeCode
 database:
 - keep the database unconverted (intended for testing and evaluation)
 - convert the database in a one-time step
-Maintaining Interoperability
+Maintaining interoperability
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Interoperability with RhodeCode 2.2.X installations is provided so you don't
 have to immediately commit to switching to Kallithea. This option will most
 likely go away once the two projects have diverged significantly.
 To run Kallithea on a RhodeCode database, run::
    echo "BRAND = 'rhodecode'" > kallithea/brand.py
 This location will depend on where you installed Kallithea. If you installed
 via::
    python setup.py install
 then you will find this location at
 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
-One-time Conversion
+One-time conversion
 ~~~~~~~~~~~~~~~~~~~
 Alternatively, if you would like to convert the database for good, you can use
 a helper script provided by Kallithea. This script will operate directly on the
 database, using the database string you can find in your ``production.ini`` (or
 ``development.ini``) file. For example, if using SQLite::
    cd /path/to/kallithea
    cp /path/to/rhodecode/rhodecode.db kallithea.db
    pip install sqlalchemy-migrate
    python kallithea/bin/rebranddb.py sqlite:///kallithea.db
 .. Note::
    If you started out using the branding interoperability approach mentioned
    above, watch out for stray brand.pyc after removing brand.py.
 Git hooks
 ~~~~~~~~~
 After switching to Kallithea, it will be necessary to update the Git_ hooks in
 your repositories. If not, the Git_ hooks from RhodeCode will still be called,
 which will cause ``git push`` to fail every time.
 If you do not have any custom Git_ hooks deployed, perform the following steps
 (this may take some time depending on the number and size of repositories you
 have):
 . Log-in as an administrator.
 . Open page *Admin > Settings > Remap and Rescan*.
 . Turn on the option **Install Git Hooks**.
 . Turn on the option **Overwrite existing Git hooks**.
 . Click on the button **Rescan Repositories**.
 If you do have custom hooks, you will need to merge those changes manually. In
 order to get sample hooks from Kallithea, the easiest way is to create a new Git_
 repository, and have a look at the hooks deployed there.
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _Python: http://www.python.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _Mercurial: http://mercurial.selenic.com/
 .. _Bitbucket: http://bitbucket.org/
 .. _GitHub: http://github.com/
 .. _Subversion: http://subversion.tigris.org/
 .. _Git: http://git-scm.com/
 .. _Celery: http://celeryproject.org/
 .. _vcs: http://pypi.python.org/pypi/vcs
 .. _Software Freedom Conservancy: http://sfconservancy.org/

development.ini

➞

Show inline comments

 ################################################################################
 ################################################################################
 # Kallithea - Development config:                                              #
 # listening on *:5000                                                          #
 # sqlite and kallithea.db                                                      #
 # initial_repo_scan = true                                                     #
 # set debug = true                                                             #
 # verbose and colorful logging                                                 #
 #                                                                              #
 # 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                                  ##
 ## Additionally those settings will be used by Kallithea mailing system       ##
 ## Email settings                                                             ##
 ##                                                                            ##
 ## Refer to the documentation ("Email settings") for more details.            ##
 ##                                                                            ##
 ## It is recommended to use a valid sender address that passes access         ##
 ## validation and spam filtering in mail servers.                             ##
 ################################################################################
 #email_to = admin@localhost
 #error_email_from = paste_error@localhost
 #app_email_from = kallithea-noreply@localhost
 #error_message =
 ## 'From' header for application emails. You can optionally add a name.
 ## Default:
 #app_email_from = Kallithea
 ## Examples:
 #app_email_from = Kallithea <kallithea-noreply@example.com>
 #app_email_from = kallithea-noreply@example.com
 ## Subject prefix for application emails.
 ## A space between this prefix and the real subject is automatically added.
 ## Default:
 #email_prefix =
 ## Example:
 #email_prefix = [Kallithea]
 ## Recipients for error emails and fallback recipients of application mails.
 ## Multiple addresses can be specified, space-separated.
 ## Only addresses are allowed, do not add any name part.
 ## Default:
 #email_to =
 ## Examples:
 #email_to = admin@example.com
 #email_to = admin@example.com another_admin@example.com
 ## 'From' header for error emails. You can optionally add a name.
 ## Default:
 #error_email_from = pylons@yourapp.com
 ## Examples:
 #error_email_from = Kallithea Errors <kallithea-noreply@example.com>
 #error_email_from = paste_error@example.com
 ## SMTP server settings
 ## Only smtp_server is mandatory. All other settings take the specified default
 ## values.
 #smtp_server = mail.server.com
 #smtp_username =
 #smtp_password =
 #smtp_port =
+#smtp_port = 25
 #smtp_use_tls = false
 #smtp_use_ssl = true
 ## Specify available auth parameters here (e.g. LOGIN PLAIN CRAM-MD5, etc.)
 #smtp_use_ssl = false
 ## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).
 ## If empty, use any of the authentication parameters supported by the server.
 #smtp_auth =
 [server:main]
 ## PASTE ##
 #use = egg:Paste#http
 ## nr of worker threads to spawn
 #threadpool_workers = 5
 ## max request before thread respawn
 #threadpool_max_requests = 10
 ## option to use threads of process
 #use_threadpool = true
 ## WAITRESS ##
 use = egg:waitress#main
 ## number of worker threads
 threads = 5
 ## MAX BODY SIZE 100GB
 max_request_body_size = 107374182400
 ## use poll instead of select, fixes fd limits, may not work on old
 ## windows systems.
 #asyncore_use_poll = True
 ## GUNICORN ##
 #use = egg:gunicorn#main
 ## number of process workers. You must set `instance_id = *` when this option
 ## is set to more than one worker
 #workers = 1
 ## process name
 #proc_name = kallithea
 ## type of worker class, one of sync, eventlet, gevent, tornado
 ## recommended for bigger setup is using of of other than sync one
 #worker_class = sync
 #max_requests = 1000
 ## ammount of time a worker can handle request before it gets killed and
 ## restarted
 #timeout = 3600
 ## UWSGI ##
 ## run with uwsgi --ini-paste-logged <inifile.ini>
 #[uwsgi]
 #socket = /tmp/uwsgi.sock
 #master = true
 #http = 127.0.0.1:5000
 ## set as deamon and redirect all output to file
 #daemonize = ./uwsgi_kallithea.log
 ## master process PID
 #pidfile = ./uwsgi_kallithea.pid
 ## stats server with workers statistics, use uwsgitop
 ## for monitoring, `uwsgitop 127.0.0.1:1717`
 #stats = 127.0.0.1:1717
 #memory-report = true
 ## log 5XX errors
 #log-5xx = true
 ## Set the socket listen queue size.
 #listen = 256
 ## Gracefully Reload workers after the specified amount of managed requests
 ## (avoid memory leaks).
 #max-requests = 1000
 ## enable large buffers
 #buffer-size=65535
+#buffer-size = 65535
 ## socket and http timeouts ##
 #http-timeout=3600
 #socket-timeout=3600
 #http-timeout = 3600
 #socket-timeout = 3600
 ## Log requests slower than the specified number of milliseconds.
 #log-slow = 10
 ## Exit if no app can be loaded.
 #need-app = true
 ## Set lazy mode (load apps in workers instead of master).
 #lazy = true
 ## scaling ##
 ## set cheaper algorithm to use, if not set default will be used
 #cheaper-algo = spare
 ## minimum number of workers to keep at all times
 #cheaper = 1
 ## number of workers to spawn at startup
 #cheaper-initial = 1
 ## maximum number of workers that can be spawned
 #workers = 4
 ## how many workers should be spawned at a time
 #cheaper-step = 1
 ## COMMON ##
 host = 0.0.0.0
 port = 5000
-## prefix middleware for rc
+## middleware for hosting the WSGI application under a URL prefix
 #[filter:proxy-prefix]
 #use = egg:PasteDeploy#prefix
 #prefix = /<your-prefix>
 [app:main]
 use = egg:kallithea
 ## enable proxy prefix middleware
 #filter-with = proxy-prefix
 full_stack = true
 static_files = true
 ## Available Languages:
 ## cs de fr hu ja nl_BE pl pt_BR ru sk zh_CN zh_TW
 lang =
 cache_dir = %(here)s/data
 index_dir = %(here)s/data/index
 ## perform a full repository scan on each server start, this should be
 ## set to false after first startup, to allow faster server restarts.
 #initial_repo_scan = false
 initial_repo_scan = true
 ## uncomment and set this path to use archive download cache
 archive_cache_dir = %(here)s/tarballcache
 ## change this to unique ID for security
 app_instance_uuid = development-not-secret
 ## 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 in Kallithea, fixes https redirects, assumes it's always https
 force_https = false
 ## use Strict-Transport-Security headers
 use_htsts = false
 ## number of commits stats will parse on each iteration
 commit_parse_limit = 25
 ## path to git executable
 git_path = git
 ## git rev filter option, --all is the default filter, if you need to
 ## hide all refs in changelog switch this to --branches --tags
 #git_rev_filter = --branches --tags
 ## 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 = false
 ## 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
 ## Kallithea url, ie. http[s]://your.kallithea.server/_admin/gists/<gistid>
 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 below are commented out:
 api_access_controllers_whitelist =
 #    ChangesetController:changeset_patch,
 #    ChangesetController:changeset_raw,
 #    FilesController:raw,
 #    FilesController:archivefile
 ## 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
 ## issue tracker for Kallithea (leave blank to disable, absent for default)
 #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
 ## fetched from the regex and {repo} is replaced with full repository name
 ## including groups {repo_name} is replaced with just name of repo
 issue_server_link = https://myissueserver.com/{repo}/issue/{id}
 ## prefix to add to link to indicate it's an url
 ## #314 will be replaced by <issue_prefix><id>
 issue_prefix = #
 ## issue_pat, issue_server_link, issue_prefix can have suffixes to specify
 ## multiple patterns, to other issues server, wiki or others
 ## below an example how to create a wiki pattern
 # wiki-some-id -> https://mywiki.com/some-id
 #issue_pat_wiki = (?:wiki-)(.+)
 #issue_server_link_wiki = https://mywiki.com/{id}
 #issue_prefix_wiki = WIKI-
 ## instance-id prefix
 ## a prefix key for this instance used for cache invalidation when running
 ## multiple instances of kallithea, make sure it's globally unique for
 ## all running kallithea instances. Leave empty if you don't use it
 instance_id =
 ## alternative return HTTP header for failed authentication. Default HTTP
 ## response is 401 HTTPUnauthorized. Currently Mercurial clients have trouble with
 ## handling that. Set this variable to 403 to return HTTPForbidden
 auth_ret_code =
 ## locking return code. When repository is locked return this HTTP code. 2XX
 ## codes don't break the transactions while 4XX codes do
 lock_ret_code = 423
 ## allows to change the repository location in settings page
 allow_repo_location_change = True
 ## allows to setup custom hooks in settings page
 allow_custom_hooks_settings = True
 ####################################
 ###        CELERY CONFIG        ####
 ####################################
 use_celery = false
 broker.host = localhost
 broker.vhost = rabbitmqhost
 broker.port = 5672
 broker.user = rabbitmq
 broker.password = qweqwe
 celery.imports = kallithea.lib.celerylib.tasks
 celery.result.backend = amqp
 celery.result.dburi = amqp://
 celery.result.serialier = json
 #celery.send.task.error.emails = true
 #celery.amqp.task.result.expires = 18000
 celeryd.concurrency = 2
 #celeryd.log.file = celeryd.log
 celeryd.log.level = DEBUG
 celeryd.max.tasks.per.child = 1
 ## tasks will never be sent to the queue, but executed locally instead.
 celery.always.eager = false
 ####################################
 ###         BEAKER CACHE        ####
 ####################################
 beaker.cache.data_dir=%(here)s/data/cache/data
 beaker.cache.lock_dir=%(here)s/data/cache/lock
 beaker.cache.regions=super_short_term,short_term,long_term,sql_cache_short,sql_cache_med,sql_cache_long
 beaker.cache.data_dir = %(here)s/data/cache/data
 beaker.cache.lock_dir = %(here)s/data/cache/lock
 beaker.cache.super_short_term.type=memory
 beaker.cache.super_short_term.expire=10
 beaker.cache.super_short_term.key_length = 256
 beaker.cache.regions = short_term,long_term,sql_cache_short
 beaker.cache.short_term.type=memory
 beaker.cache.short_term.expire=60
 beaker.cache.short_term.type = memory
 beaker.cache.short_term.expire = 60
 beaker.cache.short_term.key_length = 256
 beaker.cache.long_term.type=memory
 beaker.cache.long_term.expire=36000
 beaker.cache.long_term.type = memory
 beaker.cache.long_term.expire = 36000
 beaker.cache.long_term.key_length = 256
 beaker.cache.sql_cache_short.type=memory
 beaker.cache.sql_cache_short.expire=10
 beaker.cache.sql_cache_short.type = memory
 beaker.cache.sql_cache_short.expire = 10
 beaker.cache.sql_cache_short.key_length = 256
 beaker.cache.sql_cache_med.type=memory
 beaker.cache.sql_cache_med.expire=360
 beaker.cache.sql_cache_med.key_length = 256
 beaker.cache.sql_cache_long.type=file
 beaker.cache.sql_cache_long.expire=3600
 beaker.cache.sql_cache_long.key_length = 256
 ####################################
 ###       BEAKER SESSION        ####
 ####################################
 ## Name of session cookie. Should be unique for a given host and path, even when running
 ## on different ports. Otherwise, cookie sessions will be shared and messed up.
 beaker.session.key = kallithea
 ## Sessions should always only be accessible by the browser, not directly by JavaScript.
 beaker.session.httponly = true
 ## Session lifetime. 2592000 seconds is 30 days.
 beaker.session.timeout = 2592000
 ## Server secret used with HMAC to ensure integrity of cookies.
 beaker.session.secret = development-not-secret
 ## Further, encrypt the data with AES.
 #beaker.session.encrypt_key = <key_for_encryption>
 #beaker.session.validate_key = <validation_key>
 ## Type of storage used for the session, current types are
 ## dbm, file, memcached, database, and memory.
 ## The storage uses the Container API
 ## that is also used by the cache system.
 ## File system storage of session data. (default)
 #beaker.session.type = file
 ## db session ##
 ## Cookie only, store all session data inside the cookie. Requires secure secrets.
 #beaker.session.type = cookie
 ## Database storage of session data.
 #beaker.session.type = ext:database
 #beaker.session.sa.url = postgresql://postgres:qwe@localhost/kallithea
 #beaker.session.table_name = db_session
 ## encrypted cookie client side session, good for many instances ##
 #beaker.session.type = cookie
 ## file based cookies (default) ##
 #beaker.session.type = file
 ## beaker.session.key should be unique for a given host, even when running
 ## on different ports. Otherwise, cookie sessions will be shared and messed up.
 beaker.session.key = kallithea
 beaker.session.secret = development-not-secret
 ## Secure encrypted cookie. Requires AES and AES python libraries
 ## you must disable beaker.session.secret to use this
 #beaker.session.encrypt_key = <key_for_encryption>
 #beaker.session.validate_key = <validation_key>
 ## sets session as invalid if it haven't been accessed for given amount of time
 beaker.session.timeout = 2592000
 beaker.session.httponly = true
 #beaker.session.cookie_path = /<your-prefix>
 ## uncomment for https secure cookie
 beaker.session.secure = false
 ## auto save the session to not to use .save()
 beaker.session.auto = False
 ## default cookie expiration time in seconds `true` expire at browser close ##
 #beaker.session.cookie_expires = 3600
 ############################
 ## ERROR HANDLING SYSTEMS ##
 ############################
 ####################
 ### [errormator] ###
 ####################
 ## Errormator is tailored to work with Kallithea, see
 ## 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)
 errormator.report_404 = false
 ## time in seconds after request is considered being slow (default 1)
 errormator.slow_request_time = 1
 ## record slow requests in application
 ## (needs to be enabled for slow datastore recording and time tracking)
 errormator.slow_requests = true
 ## enable hooking to application loggers
-# errormator.logging = true
 #errormator.logging = true
 ## minimum log level for log capture
-# errormator.logging.level = WARNING
 #errormator.logging.level = WARNING
 ## send logs only from erroneous/slow requests
 ## (saves API quota for intensive logging)
 errormator.logging_on_error = false
 ## list of additonal keywords that should be grabbed from environ object
 ## can be string with comma separated list of words in lowercase
 ## (by default client will always send following info:
 ## 'REMOTE_USER', 'REMOTE_ADDR', 'SERVER_NAME', 'CONTENT_TYPE' + all keys that
 ## start with HTTP* this list be extended with additional keywords here
 errormator.environ_keys_whitelist =
 ## list of keywords that should be blanked from request object
 ## can be string with comma separated list of words in lowercase
 ## (by default client will always blank keys that contain following words
 ## 'password', 'passwd', 'pwd', 'auth_tkt', 'secret', 'csrf'
 ## this list be extended with additional keywords set here
 errormator.request_keys_blacklist =
 ## list of namespaces that should be ignores when gathering log entries
 ## can be string with comma separated list of namespaces
 ## (by default the client ignores own entries: errormator_client.client)
 errormator.log_namespace_blacklist =
 ################
 ### [sentry] ###
 ################
 ## sentry is a alternative open source error aggregator
 ## you must install python packages `sentry` and `raven` to enable
 sentry.dsn = YOUR_DNS
 sentry.servers =
 sentry.name =
 sentry.key =
 sentry.public_key =
 sentry.secret_key =
 sentry.project =
 sentry.site =
 sentry.include_paths =
 sentry.exclude_paths =
 ################################################################################
 ## WARNING: *THE LINE BELOW MUST BE UNCOMMENTED ON A PRODUCTION ENVIRONMENT*  ##
 ## Debug mode will enable the interactive debugging tool, allowing ANYONE to  ##
 ## execute malicious code after an exception is raised.                       ##
 ################################################################################
 #set debug = false
 set debug = true
 ##################################
 ###       LOGVIEW CONFIG       ###
 ##################################
 logview.sqlalchemy = #faa
 logview.pylons.templating = #bfb
 logview.pylons.util = #eee
 #########################################################
 ### DB CONFIGS - EACH DB WILL HAVE IT'S OWN CONFIG    ###
 #########################################################
 # SQLITE [default]
 sqlalchemy.db1.url = sqlite:///%(here)s/kallithea.db?timeout=60
 # POSTGRESQL
-# sqlalchemy.db1.url = postgresql://user:pass@localhost/kallithea
 #sqlalchemy.db1.url = postgresql://user:pass@localhost/kallithea
 # MySQL
-# sqlalchemy.db1.url = mysql://user:pass@localhost/kallithea
 #sqlalchemy.db1.url = mysql://user:pass@localhost/kallithea
 # see sqlalchemy docs for others
 sqlalchemy.db1.echo = false
 sqlalchemy.db1.pool_recycle = 3600
 sqlalchemy.db1.convert_unicode = true
 ################################
 ### LOGGING CONFIGURATION   ####
 ################################
 [loggers]
 keys = root, routes, kallithea, sqlalchemy, beaker, templates, whoosh_indexer
 [handlers]
 keys = console, console_sql
 [formatters]
 keys = generic, color_formatter, color_formatter_sql
 #############
 ## LOGGERS ##
 #############
 [logger_root]
 level = NOTSET
 handlers = console
 [logger_routes]
 level = DEBUG
 handlers =
 qualname = routes.middleware
 ## "level = DEBUG" logs the route matched and routing variables.
 propagate = 1
 [logger_beaker]
 level = DEBUG
 handlers =
 qualname = beaker.container
 propagate = 1
 [logger_templates]
 level = INFO
 handlers =
 qualname = pylons.templating
 propagate = 1
 [logger_kallithea]
 level = DEBUG
 handlers =
 qualname = kallithea
 propagate = 1
 [logger_sqlalchemy]
 level = INFO
 handlers = console_sql
 qualname = sqlalchemy.engine
 propagate = 0
 [logger_whoosh_indexer]
 level = DEBUG
 handlers =
 qualname = whoosh_indexer
 propagate = 1
 ##############
 ## HANDLERS ##
 ##############
 [handler_console]
 class = StreamHandler
 args = (sys.stderr,)
 #level = INFO
 #formatter = generic
 level = DEBUG
 formatter = color_formatter
 [handler_console_sql]
 class = StreamHandler
 args = (sys.stderr,)
 #level = WARN
 #formatter = generic
 level = DEBUG
 formatter = color_formatter_sql
 ################
 ## FORMATTERS ##
 ################
 [formatter_generic]
 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
 datefmt = %Y-%m-%d %H:%M:%S
 [formatter_color_formatter]
 class=kallithea.lib.colored_formatter.ColorFormatter
 format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
 class = kallithea.lib.colored_formatter.ColorFormatter
 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
 datefmt = %Y-%m-%d %H:%M:%S
 [formatter_color_formatter_sql]
 class=kallithea.lib.colored_formatter.ColorFormatterSql
 format= %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
 class = kallithea.lib.colored_formatter.ColorFormatterSql
 format = %(asctime)s.%(msecs)03d %(levelname)-5.5s [%(name)s] %(message)s
 datefmt = %Y-%m-%d %H:%M:%S

docs/api/api.rst

➞

Show inline comments

 .. _api:
 ===
 API
 ===
 Kallithea has a simple JSON RPC API with a single schema for calling all API
 methods. Everything is available by sending JSON encoded http(s) requests to
-<your_server>/_admin/api .
+``<your_server>/_admin/api``.
 API access for web views
 ++++++++++++++++++++++++
 API access can also be turned on for each web view in Kallithea that is
 decorated with the ``@LoginRequired`` decorator. Some views use
 ``@LoginRequired(api_access=True)`` and are always available. By default only
 RSS/ATOM feed views are enabled. Other views are
 only available if they have been white listed. Edit the
 RSS/Atom feed views are enabled. Other views are
 only available if they have been whitelisted. Edit the
 ``api_access_controllers_whitelist`` option in your .ini file and define views
 that should have API access enabled.
 For example, to enable API access to patch/diff raw file and archive::
+For example, to enable API access to patch/diff, raw file and archive::
     api_access_controllers_whitelist =
         ChangesetController:changeset_patch,
         ChangesetController:changeset_raw,
         FilesController:raw,
         FilesController:archivefile
 After this change, a Kallithea view can be accessed without login by adding a
 GET parameter ``?api_key=<api_key>`` to the URL.
 Exposing raw diffs is a good way to integrate with
-rd party services like code review, or build farms that could download archives.
+third-party services like code review, or build farms that can download archives.
 API access
 ++++++++++
 Clients must send JSON encoded JSON-RPC requests::
+    {
         "id: "<id>",
         "api_key": "<api_key>",
         "method": "<method_name>",
         "args": {"<arg_key>": "<arg_val>"}
+    }
 For example, to pull to a local "CPython" mirror using curl::
     curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
     curl https://example.com/_admin/api -X POST -H 'content-type:text/plain' \
         --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
 In general, provide
  - *id*, a value of any type, can be used to match the response with the request that it is replying to.
  - *api_key*, for authentication and permission validation.
  - *method*, the name of the method to call - a list of available methods can be found below.
+ - *method*, the name of the method to call -- a list of available methods can be found below.
  - *args*, the arguments to pass to the method.
 .. note::
     api_key can be found or set on the user account page
+    api_key can be found or set on the user account page.
 The response to the JSON-RPC API call will always be a JSON structure::
+    {
         "id":<id>, # the id that was used in the request
         "result": "<result>"|null, # JSON formatted result, null if any errors
         "error": "null"|<error_message> # JSON formatted error (if any)
         "id": <id>,  # the id that was used in the request
         "result": <result>|null,  # JSON formatted result (null on error)
         "error": null|<error_message>  # JSON formatted error (null on success)
+    }
-All responses from API will be ``HTTP/1.0 200 OK``. If there is an error,
+All responses from the API will be ``HTTP/1.0 200 OK``. If an error occurs,
 the reponse will have a failure description in *error* and
 *result* will be null.
 API client
 ++++++++++
 Kallithea comes with a ``kallithea-api`` command line tool providing a convenient
+Kallithea comes with a ``kallithea-api`` command line tool, providing a convenient
 way to call the JSON-RPC API.
 For example, to call ``get_repo``::
  kallithea-api --apihost=<your.kallithea.server.url> --apikey=<yourapikey> get_repo
  calling {"api_key": "<apikey>", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000
  Kallithea said:
  {'error': 'Missing non optional `repoid` arg in JSON DATA',
   'id': 75,
   'result': None}
 Oops, looks like we forgot to add an argument. Let's try again, now
 providing the ``repoid`` as a parameter::
     kallithea-api get_repo repoid:myrepo
     calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "myrepo"}, "method": "get_repo"} to http://127.0.0.1:5000
     Kallithea said:
     {'error': None,
      'id': 39,
      'result': <json data...>}
 To avoid specifying ``apihost`` and ``apikey`` every time, run::
   kallithea-api --save-config --apihost=<your.kallithea.server.url> --apikey=<yourapikey>
-This will create a ``~/.config/kallithea`` with the specified hostname and apikey
+This will create a ``~/.config/kallithea`` with the specified hostname and API key
 so you don't have to specify them every time.
 API methods
 +++++++++++
 pull
 ----
 Pull the given repo from remote location. Can be used to automatically keep
 remote repos up to date.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "pull"
     args :    {
                 "repoid" : "<reponame or repo_id>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : "Pulled from `<reponame>`"
     error :  null
 rescan_repos
 ------------
 Rescan repositories. If ``remove_obsolete`` is set,
 Kallithea will delete repos that are in the database but not in the filesystem.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "rescan_repos"
     args :    {
                 "remove_obsolete" : "<boolean = Optional(False)>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : "{'added': [<list of names of added repos>],
                'removed': [<list of names of removed repos>]}"
     error :  null
 invalidate_cache
 ----------------
 Invalidate the cache for a repository.
 This command can only be executed using the api_key of a user with admin rights,
 or that of a regular user with admin or write access to the repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "invalidate_cache"
     args :    {
                 "repoid" : "<reponame or repo_id>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : "Caches of repository `<reponame>`"
     error :  null
 lock
 ----
 Set the locking state on the given repository by the given user.
 If the param ``userid`` is skipped, it is set to the ID of the user who is calling this method.
 If param ``locked`` is skipped, the current lock state of the repository is returned.
 This command can only be executed using the api_key of a user with admin rights, or that of a regular user with admin or write access to the repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "lock"
     args :    {
                 "repoid" : "<reponame or repo_id>"
                 "userid" : "<user_id or username = Optional(=apiuser)>",
                 "locked" : "<bool true|false = Optional(=None)>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : {
                  "repo": "<reponame>",
                  "locked": "<bool true|false>",
                  "locked_since": "<float lock_time>",
                  "locked_by": "<username>",
                  "msg": "User `<username>` set lock state for repo `<reponame>` to `<false|true>`"
+             }
     error :  null
 get_ip
 ------
 Return IP address as seen from Kallithea server, together with all
 defined IP addresses for given user.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_ip"
     args :    {
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : {
                  "ip_addr_server": <ip_from_clien>",
                  "user_ips": [
+                                {
                                    "ip_addr": "<ip_with_mask>",
                                    "ip_range": ["<start_ip>", "<end_ip>"],
                                 },
                                 ...
+                             ]
+             }
     error :  null
 get_user
 --------
 Get a user by username or userid. The result is empty if user can't be found.
 If userid param is skipped, it is set to id of user who is calling this method.
 Any userid can be specified when the command is executed using the api_key of a user with admin rights.
 Regular users can only speicy their own userid.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_user"
     args :    {
                 "userid" : "<username or user_id Optional(=apiuser)>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: None if user does not exist or
+            {
                 "user_id" :     "<user_id>",
                 "api_key" :     "<api_key>",
                 "username" :    "<username>",
                 "firstname":    "<firstname>",
                 "lastname" :    "<lastname>",
                 "email" :       "<email>",
                 "emails":       "<list_of_all_additional_emails>",
                 "ip_addresses": "<list_of_ip_addresses_for_user>",
                 "active" :      "<bool>",
                 "admin" :       "<bool>",
                 "ldap_dn" :     "<ldap_dn>",
                 "last_login":   "<last_login>",
                 "permissions": {
                     "global": ["hg.create.repository",
                                "repository.read",
                                "hg.register.manual_activate"],
                     "repositories": {"repo1": "repository.none"},
                     "repositories_groups": {"Group1": "group.read"}
                  },
+            }
     error:  null
 get_users
 ---------
 List all existing users.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_users"
     args :    { }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+              {
                 "user_id" :     "<user_id>",
                 "api_key" :     "<api_key>",
                 "username" :    "<username>",
                 "firstname":    "<firstname>",
                 "lastname" :    "<lastname>",
                 "email" :       "<email>",
                 "emails":       "<list_of_all_additional_emails>",
                 "ip_addresses": "<list_of_ip_addresses_for_user>",
                 "active" :      "<bool>",
                 "admin" :       "<bool>",
                 "ldap_dn" :     "<ldap_dn>",
                 "last_login":   "<last_login>",
               },
               …
+            ]
     error:  null
 .. _create-user:
 create_user
 -----------
 Create new user.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "create_user"
     args :    {
                 "username" :  "<username>",
                 "email" :     "<useremail>",
                 "password" :  "<password = Optional(None)>",
                 "firstname" : "<firstname> = Optional(None)",
                 "lastname" :  "<lastname> = Optional(None)",
                 "active" :    "<bool> = Optional(True)",
                 "admin" :     "<bool> = Optional(False)",
                 "ldap_dn" :   "<ldap_dn> = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "created new user `<username>`",
               "user": {
                 "user_id" :  "<user_id>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
                 "emails":    "<list_of_all_additional_emails>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>",
                 "last_login": "<last_login>",
               },
+            }
     error:  null
 Example::
     kallithea-api create_user username:bent email:bent@example.com firstname:Bent lastname:Bentsen extern_type:ldap extern_name:uid=bent,dc=example,dc=com
 update_user
 -----------
 Update the given user if such user exists.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "update_user"
     args :    {
                 "userid" : "<user_id or username>",
                 "username" :  "<username> = Optional(None)",
                 "email" :     "<useremail> = Optional(None)",
                 "password" :  "<password> = Optional(None)",
                 "firstname" : "<firstname> = Optional(None)",
                 "lastname" :  "<lastname> = Optional(None)",
                 "active" :    "<bool> = Optional(None)",
                 "admin" :     "<bool> = Optional(None)",
                 "ldap_dn" :   "<ldap_dn> = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "updated user ID:<userid> <username>",
               "user": {
                 "user_id" :  "<user_id>",
                 "api_key" :  "<api_key>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
                 "emails":    "<list_of_all_additional_emails>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>",
                 "last_login": "<last_login>",
               },
+            }
     error:  null
 delete_user
 -----------
 Delete the given user if such a user exists.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "delete_user"
     args :    {
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "deleted user ID:<userid> <username>",
               "user": null
+            }
     error:  null
 get_user_group
 --------------
 Get an existing user group.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_user_group"
     args :    {
                 "usergroupid" : "<user group id or name>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : None if group not exist
+             {
                "users_group_id" : "<id>",
                "group_name" :     "<groupname>",
                "active":          "<bool>",
                "members" :  [
+                              {
                                 "user_id" :  "<user_id>",
                                 "api_key" :  "<api_key>",
                                 "username" : "<username>",
                                 "firstname": "<firstname>",
                                 "lastname" : "<lastname>",
                                 "email" :    "<email>",
                                 "emails":    "<list_of_all_additional_emails>",
                                 "active" :   "<bool>",
                                 "admin" :    "<bool>",
                                 "ldap_dn" :  "<ldap_dn>",
                                 "last_login": "<last_login>",
                               },
                               …
+                            ]
+             }
     error : null
 get_user_groups
 ---------------
 List all existing user groups.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_user_groups"
     args :    { }
 OUTPUT::
     id : <id_given_in_input>
     result : [
+               {
                "users_group_id" : "<id>",
                "group_name" :     "<groupname>",
                "active":          "<bool>",
                },
                …
+              ]
     error : null
 create_user_group
 -----------------
 Create a new user group.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "create_user_group"
     args:     {
                 "group_name": "<groupname>",
-                "owner" :     "<onwer_name_or_id = Optional(=apiuser)>",
+                "owner" :     "<owner_name_or_id = Optional(=apiuser)>",
                 "active":     "<bool> = Optional(True)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "created new user group `<groupname>`",
               "users_group": {
                      "users_group_id" : "<id>",
                      "group_name" :     "<groupname>",
                      "active":          "<bool>",
                },
+            }
     error:  null
 add_user_to_user_group
 ----------------------
 Adds a user to a user group. If the user already is in that group, success will be
 ``false``.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "add_user_user_group"
     args:     {
                 "usersgroupid" : "<user group id or name>",
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "success": True|False # depends on if member is in group
               "msg": "added member `<username>` to a user group `<groupname>` |
                       User is already in that group"
+            }
     error:  null
 remove_user_from_user_group
 ---------------------------
 Remove a user from a user group. If the user isn't in the given group, success will
 be ``false``.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "remove_user_from_user_group"
     args:     {
                 "usersgroupid" : "<user group id or name>",
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "success":  True|False,  # depends on if member is in group
               "msg": "removed member <username> from user group <groupname> |
                       User wasn't in group"
+            }
     error:  null
 get_repo
 --------
 Get an existing repository by its name or repository_id. Members will contain
 either users_group or users associated to that repository.
 This command can only be executed using the api_key of a user with admin rights,
 or that of a regular user with at least read access to the repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repo"
     args:     {
                 "repoid" : "<reponame or repo_id>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: None if repository does not exist or
+            {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
                 "enable_downloads":  "<bool>",
                 "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
                 "private":           "<bool>",
                 "created_on" :       "<date_time_created>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "last_changeset":    {
                                        "author":   "<full_author>",
                                        "date":     "<date_time_of_commit>",
                                        "message":  "<commit_message>",
                                        "raw_id":   "<raw_id>",
                                        "revision": "<numeric_revision>",
                                        "short_id": "<short_id>"
+                                     }
                 "owner":             "<repo_owner>",
                 "fork_of":           "<name_of_fork_parent>",
                 "members" :     [
+                                  {
                                     "type":        "user",
                                     "user_id" :    "<user_id>",
                                     "api_key" :    "<api_key>",
                                     "username" :   "<username>",
                                     "firstname":   "<firstname>",
                                     "lastname" :   "<lastname>",
                                     "email" :      "<email>",
                                     "emails":      "<list_of_all_additional_emails>",
                                     "active" :     "<bool>",
                                     "admin" :      "<bool>",
                                     "ldap_dn" :    "<ldap_dn>",
                                     "last_login":  "<last_login>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …
+                                  {
                                     "type":      "users_group",
                                     "id" :       "<usersgroupid>",
                                     "name" :     "<usersgroupname>",
                                     "active":    "<bool>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …
+                                ]
                  "followers":   [
+                                  {
                                     "user_id" :     "<user_id>",
                                     "username" :    "<username>",
                                     "api_key" :     "<api_key>",
                                     "firstname":    "<firstname>",
                                     "lastname" :    "<lastname>",
                                     "email" :       "<email>",
                                     "emails":       "<list_of_all_additional_emails>",
                                     "ip_addresses": "<list_of_ip_addresses_for_user>",
                                     "active" :      "<bool>",
                                     "admin" :       "<bool>",
                                     "ldap_dn" :     "<ldap_dn>",
                                     "last_login":   "<last_login>",
                                   },
                                   …
+                 ]
+            }
     error:  null
 get_repos
 ---------
 List all existing repositories.
 This command can only be executed using the api_key of a user with admin rights,
 or that of a regular user with at least read access to the repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repos"
     args:     { }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+              {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
-                "private": :         "<bool>",
+                "private" :          "<bool>",
                 "created_on" :       "<datetimecreated>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "owner":             "<repo_owner>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
                 "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
               },
               …
+            ]
     error:  null
 get_repo_nodes
 --------------
 Return a list of files and directories for a given path at the given revision.
 It is possible to specify ret_type to show only ``files`` or ``dirs``.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repo_nodes"
     args:     {
                 "repoid" : "<reponame or repo_id>"
                 "revision"  : "<revision>",
                 "root_path" : "<root_path>",
                 "ret_type"  : "<ret_type> = Optional('all')"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+              {
                 "name" :        "<name>"
                 "type" :        "<type>",
               },
               …
+            ]
     error:  null
 create_repo
 -----------
 Create a repository. If the repository name contains "/", all needed repository
 groups will be created. For example "foo/bar/baz" will create repository groups
 "foo", "bar" (with "foo" as parent), and create "baz" repository with
 "bar" as group.
 This command can only be executed using the api_key of a user with admin rights,
 or that of a regular user with create repository permission.
 Regular users cannot specify owner parameter.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "create_repo"
     args:     {
                 "repo_name" :        "<reponame>",
-                "owner" :            "<onwer_name_or_id = Optional(=apiuser)>",
+                "owner" :            "<owner_name_or_id = Optional(=apiuser)>",
                 "repo_type" :        "<repo_type> = Optional('hg')",
                 "description" :      "<description> = Optional('')",
                 "private" :          "<bool> = Optional(False)",
                 "clone_uri" :        "<clone_uri> = Optional(None)",
                 "landing_rev" :      "<landing_rev> = Optional('tip')",
                 "enable_downloads":  "<bool> = Optional(False)",
                 "enable_locking":    "<bool> = Optional(False)",
                 "enable_statistics": "<bool> = Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "Created new repository `<reponame>`",
               "repo": {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
-                "private": :         "<bool>",
+                "private" :          "<bool>",
                 "created_on" :       "<datetimecreated>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "owner":             "<username or user_id>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
                 "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
               },
+            }
     error:  null
 update_repo
 -----------
 Update a repository.
 This command can only be executed using the api_key of a user with admin rights,
 or that of a regular user with create repository permission.
 Regular users cannot specify owner parameter.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "update_repo"
     args:     {
                 "repoid" :           "<reponame or repo_id>"
                 "name" :             "<reponame> = Optional('')",
                 "group" :            "<group_id> = Optional(None)",
                 "owner" :            "<owner_name_or_id = Optional(=apiuser)>",
                 "description" :      "<description> = Optional('')",
                 "private" :          "<bool> = Optional(False)",
                 "clone_uri" :        "<clone_uri> = Optional(None)",
                 "landing_rev" :      "<landing_rev> = Optional('tip')",
                 "enable_downloads":  "<bool> = Optional(False)",
                 "enable_locking":    "<bool> = Optional(False)",
                 "enable_statistics": "<bool> = Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "updated repo ID:repo_id `<reponame>`",
               "repository": {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
                 "private":           "<bool>",
                 "created_on" :       "<datetimecreated>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "owner":             "<username or user_id>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
                 "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
                 "last_changeset":    {
                                        "author":   "<full_author>",
                                        "date":     "<date_time_of_commit>",
                                        "message":  "<commit_message>",
                                        "raw_id":   "<raw_id>",
                                        "revision": "<numeric_revision>",
                                        "short_id": "<short_id>"
+                                     }
                 "locked_by": "<username>",
                 "locked_date": "<float lock_time>",
               },
+            }
     error:  null
 fork_repo
 ---------
 Create a fork of the given repo. If using Celery, this will
 return success message immediately and a fork will be created
 asynchronously.
 This command can only be executed using the api_key of a user with admin
 rights, or with the global fork permission, by a regular user with create
 repository permission and at least read access to the repository.
 Regular users cannot specify owner parameter.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "fork_repo"
     args:     {
                 "repoid" :          "<reponame or repo_id>",
                 "fork_name":        "<forkname>",
                 "owner":            "<username or user_id = Optional(=apiuser)>",
                 "description":      "<description>",
                 "copy_permissions": "<bool>",
                 "private":          "<bool>",
                 "landing_rev":      "<landing_rev>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "Created fork of `<reponame>` as `<forkname>`",
               "success": true
+            }
     error:  null
 delete_repo
 -----------
 Delete a repository.
 This command can only be executed using the api_key of a user with admin rights,
 or that of a regular user with admin access to the repository.
 When ``forks`` param is set it is possible to detach or delete forks of the deleted repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "delete_repo"
     args:     {
                 "repoid" : "<reponame or repo_id>",
                 "forks"  : "`delete` or `detach` = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "Deleted repository `<reponame>`",
               "success": true
+            }
     error:  null
 grant_user_permission
 ---------------------
 Grant permission for a user on the given repository, or update the existing one if found.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "grant_user_permission"
     args:     {
                 "repoid" : "<reponame or repo_id>"
                 "userid" : "<username or user_id>"
                 "perm" :       "(repository.(none|read|write|admin))",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
 revoke_user_permission
 ----------------------
 Revoke permission for a user on the given repository.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "revoke_user_permission"
     args:     {
                 "repoid" : "<reponame or repo_id>"
                 "userid" : "<username or user_id>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
 grant_user_group_permission
 ---------------------------
 Grant permission for a user group on the given repository, or update the
 existing one if found.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "grant_user_group_permission"
     args:     {
                 "repoid" : "<reponame or repo_id>"
                 "usersgroupid" : "<user group id or name>"
                 "perm" : "(repository.(none|read|write|admin))",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
 revoke_user_group_permission
 ----------------------------
 Revoke permission for a user group on the given repository.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "revoke_user_group_permission"
     args:     {
                 "repoid" : "<reponame or repo_id>"
                 "usersgroupid" : "<user group id or name>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null

docs/api/models.rst

➞

Show inline comments

 .. _models:
 ========================
-The :mod:`models` Module
+The :mod:`models` module
 ========================
 .. automodule:: kallithea.model
    :members:
 .. automodule:: kallithea.model.comment
    :members:
 .. automodule:: kallithea.model.notification
    :members:
 .. automodule:: kallithea.model.permission
    :members:
 .. automodule:: kallithea.model.repo_permission
    :members:
 .. automodule:: kallithea.model.repo
    :members:
 .. automodule:: kallithea.model.repo_group
    :members:
 .. automodule:: kallithea.model.scm
    :members:
 .. automodule:: kallithea.model.user
    :members:
 .. automodule:: kallithea.model.user_group
    :members:

docs/changelog.rst

➞

Show inline comments

 .. _changelog:
 =========
 Changelog
 =========
-Kallithea project doesn't keep its changelog here.  We refer you to our Mercurial logs_ .
+Kallithea project doesn't keep its changelog here.  We refer you to our `Mercurial logs`__.
 .. _logs: https://kallithea-scm.org/repos/kallithea/changelog
 .. __: https://kallithea-scm.org/repos/kallithea/changelog

docs/conf.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
+#
 # Kallithea documentation build configuration file, created by
 # sphinx-quickstart on Sun Oct 10 16:46:37 2010.
+#
 # This file is execfile()d with the current directory set to its containing dir.
+#
 # Note that not all possible configuration values are present in this
 # autogenerated file.
+#
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 import sys
 import os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
 # -- General configuration -----------------------------------------------------
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
               'sphinx.ext.intersphinx', 'sphinx.ext.todo',
               'sphinx.ext.viewcode']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 # The suffix of source filenames.
 source_suffix = '.rst'
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
 # The master toctree document.
 master_doc = 'index'
 # General information about the project.
 project = u'Kallithea'
 copyright = u'2010-2015 by various authors, licensed as GPLv3.'
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
+#
 # The short X.Y version.
 root = os.path.dirname(os.path.dirname(__file__))
 sys.path.append(root)
 from kallithea import __version__
 version = __version__
 # The full version, including alpha/beta/rc tags.
 release = __version__
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 #add_module_names = True
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
 #show_authors = False
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 highlight_language = 'none'
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 # -- Options for HTML output ---------------------------------------------------
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'nature'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #html_theme_options = {}
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ['theme']
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 #html_title = None
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #html_logo = None
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #html_favicon = None
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 #html_static_path = ['_static']
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 #html_last_updated_fmt = '%b %d, %Y'
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #html_use_smartypants = True
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #html_additional_pages = {}
 # If false, no module index is generated.
 #html_domain_indices = True
 # If false, no index is generated.
 #html_use_index = True
 # If true, the index is split into individual pages for each letter.
 #html_split_index = False
 # If true, links to the reST sources are added to the pages.
 #html_show_sourcelink = True
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 #html_show_sphinx = True
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 #html_show_copyright = True
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = None
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Kallithea-docs'
 # -- Options for LaTeX output --------------------------------------------------
 # The paper size ('letter' or 'a4').
 #latex_paper_size = 'letter'
 # The font size ('10pt', '11pt' or '12pt').
 #latex_font_size = '10pt'
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'Kallithea.tex', u'Kallithea Documentation',
    u'Kallithea Developers', 'manual'),
+]
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 #latex_logo = None
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 #latex_use_parts = False
 # If true, show page references after internal links.
 #latex_show_pagerefs = False
 # If true, show URL addresses after external links.
 #latex_show_urls = False
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
 # If false, no module index is generated.
 #latex_domain_indices = True
 # -- Options for manual page output --------------------------------------------
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'kallithea', u'Kallithea Documentation',
      [u'Kallithea Developers'], 1)
+]
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}

docs/contributing.rst

➞

Show inline comments

 .. _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 at Our Own Kallithea (aka OOK) on
 https://kallithea-scm.org/repos/kallithea/ (which is our self-hosted instance
 of Kallithea).
 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 Tracker`_ services. The
 issue tracker is for tracking bugs, not for support, discussion, or ideas -
 please use the `mailing list`_ to reach the community.
 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
         python 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
 -------------
 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 python2.6-2.7 with multiple database test.
+run ``tox`` for Python 2.6--2.7 with multiple database test.
 When using `nosetests`, the `test.ini` file is used with an SQLite database. Edit
 this file to change your testing enviroment.
 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 test.ini --pid-file=test.pid --daemon
+    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 (http://mercurial.selenic.com/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. IE8 is still supported
 to the extent it is feasible but we may stop supporting it very soon.
 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
+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 classes and ids that can be used for styling and testing.
+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).
+``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
 {}. jQuery value arrays should have a leading $.
 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.
 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.
 Contributions will be accepted in most formats - such as pull requests on
 .. _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
-mail to the kallithea-general mailing list.
+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
+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
+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 Tracker: https://bitbucket.org/conservancy/kallithea/issues?status=new&status=open
 .. _Pull Requests: https://bitbucket.org/conservancy/kallithea/pull-requests
 .. _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/index.rst

➞

Show inline comments

 .. _index:
 #######################
 Kallithea Documentation
------------------------
+#######################
 **Readme**
 .. toctree::
    :maxdepth: 1
    readme
 **Installation**
 .. toctree::
    :maxdepth: 1
    overview
    installation
    installation_win
    installation_win_old
    installation_iis
    setup
 **Usage**
 .. toctree::
    :maxdepth: 1
    usage/general
    usage/vcs_support
    usage/locking
    usage/statistics
-**Administrators Guide**
+**Administrator's guide**
 .. toctree::
    :maxdepth: 1
    usage/email
    usage/performance
    usage/backup
    usage/debugging
    usage/troubleshooting
-**Develop**
+**Development**
 .. toctree::
    :maxdepth: 1
    contributing
    changelog
 **API**
 .. toctree::
    :maxdepth: 1
    api/api
    api/models
 Other topics
 ------------
 * :ref:`genindex`
 * :ref:`search`
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
 .. _bitbucket: http://bitbucket.org/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _vcs: http://pypi.python.org/pypi/vcs

docs/installation.rst

➞

Show inline comments

 .. _installation:
 ==========================
 Installation on Unix/Linux
 ==========================
 **Kallithea** is written entirely in Python_ and requires Python version
 .6 or higher. Python 3.x is currently not supported.
 There are several ways to install Kallithea:
 The following describes three different ways of installing Kallithea:
 - :ref:`installation-source`: The Kallithea development repository is stable
   and can be used in production. In fact, the Kallithea maintainers do
   use it in production. The advantage of installation from source and regularly
   updating it is that you take advantage of the most recent improvements, which
   is particularly useful because Kallithea is evolving rapidly.
 - :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
+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
         python setup.py develop
         python 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 by running::
     source /srv/kallithea/venv/bin/activate
 .. 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::
     pip install kallithea
   Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,
   extract it and run::
     python setup.py 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
 .. _Python: http://www.python.org/
 .. _pylons: http://www.pylonsproject.org/

docs/installation_iis.rst

➞

Show inline comments

 .. _installation_iis:
 =====================================================================
 Installing Kallithea on Microsoft Internet Information Services (IIS)
 =====================================================================
 The following is documented using IIS 7/8 terminology. There should be nothing
 preventing you from applying this on IIS 6 well.
 .. note::
     For the best security, it is strongly recommended to only host the site over
     a secure connection, e.g. using TLS.
 Prerequisites
 -------------
 Apart from the normal requirements for Kallithea, it is also necessary to get an
 ISAPI-WSGI bridge module, e.g. isapi-wsgi.
 Installation
 ------------
-The following will assume that your Kallithea is at ``c:\inetpub\kallithea`` and
+The following assumes that your Kallithea is at ``c:\inetpub\kallithea``, and
 will be served from the root of its own website. The changes to serve it in its
 own virtual folder will be noted where appropriate.
-Application Pool
+Application pool
 ................
 Make sure that there is a unique application pool for the Kallithea application
 with an identity that has read access to the Kallithea distribution.
 The application pool does not need to be able to run any managed code. If you
 are using a 32-bit Python installation, then you must enable 32 bit program in
 the advanced settings for the application pool otherwise Python will not be able
 to run on the website and consequently, Kallithea will not be able to run.
 are using a 32-bit Python installation, then you must enable 32-bit program in
 the advanced settings for the application pool; otherwise Python will not be able
 to run on the website and neither will Kallithea.
 .. note::
     The application pool can be the same as an existing application pool as long
     as the requirements to Kallithea are enabled by the existing application
     pool.
     The application pool can be the same as an existing application pool,
     as long as the Kallithea requirements are met by the existing pool.
-ISAPI Handler
+ISAPI handler
 .............
 The ISAPI handler can be generated using::
     paster install-iis my.ini --root=/
 This will generate a ``dispatch.py`` file in the current directory that contains
 the necessary components to finalize an installation into IIS. Once this file
 has been generated, it is necessary to run the following command due to the way
 that ISAPI-WSGI is made::
     python dispatch.py install
 This accomplishes two things: generating an ISAPI compliant DLL file,
 ``_dispatch.dll``, and installing a script map handler into IIS for the
 ``--root`` specified above pointing to ``_dispatch.dll``.
 The ISAPI handler is registered to all file extensions, so it will automatically
 be the one handling all requests to the specified root. When the website starts
 the ISAPI handler, it will start a thread pool managed wrapper around the paster
 middleware WSGI handler that Kallithea runs within and each HTTP request to the
 site will be processed through this logic henceforth.
 Authentication with Kallithea using IIS authentication modules
 ..............................................................
 The recommended way to handle authentication with Kallithea using IIS is to let
 IIS handle all the authentication and just pass it to Kallithea.
 To move responsibility into IIS from Kallithea, we need to configure Kallithea
 to let external systems handle authentication and then let Kallithea create the
 user automatically. To do this, access the administration's authentication page
 and enable the ``kallithea.lib.auth_modules.auth_container`` plugin. Once it is
 added, enable it with the ``REMOTE_USER`` header and check *Clean username*.
 Finally, save the changes on this page.
 Switch to the administration's permissions page and disable anonymous access,
 otherwise Kallithea will not attempt to use the authenticated user name. By
 default, Kallithea will populate the list of users lazily as they log in. Either
 disable external auth account activation and ensure that you pre-populate the
 user database with an external tool, or set it to *Automatic activation of
 external account*. Finally, save the changes.
 The last necessary step is to enable the relevant authentication in IIS, e.g.
 Windows authentication.
 Troubleshooting
 ---------------
 Typically, any issues in this setup will either be entirely in IIS or entirely
 in Kallithea (or Kallithea's WSGI/paster middleware). Consequently, two
 different options for finding issues exist: IIS' failed request tracking which
 is great at finding issues until they exist inside Kallithea, at which point the
 ISAPI-WSGI wrapper above uses ``win32traceutil``, which is part of ``pywin32``.
 In order to dump output from WSGI using ``win32traceutil`` it is sufficient to
 type the following in a console window::
     python -m win32traceutil
 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
 traces, making it a lot easier to identify issues.

docs/installation_win.rst

➞

Show inline comments

 .. _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
 -----------------------
 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
 -------------------
 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
 -----------------------------------
 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
 --------------------
 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 "python 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
 -----------------------------------
 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
 ---------------------------
 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
 --------------------------
 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
 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 - (Optional) Install git
 -------------------------------
 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
 ------------------------------
 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 "admin@xxxx.com" (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
 ---------------------------
 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

➞

Show inline comments

 .. _installation_win_old:
+======================================================================
 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
 ======================================================================
 First time install
 First-time install
 ::::::::::::::::::
-Target OS: Windows XP SP3 32bit English (Clean installation)
+Target OS: Windows XP SP3 32-bit English (Clean installation)
 + All Windows Updates until 24-may-2012
 .. note::
    This installation is for 32bit systems, for 64bit windows you might need
    to download proper 64bit versions of the different packages(Windows Installer, Win32py extensions)
    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 "64bit".
+   These extra steps haven been marked as "64-bit".
    Tested on Windows Server 2008 R2 SP1, 9-feb-2013.
    If you run into any 64bit related problems, please check these pages:
    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
 Step1 - Install Visual Studio 2008 Express
 ------------------------------------------
 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 "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::
-bit: You also need to install the Microsoft Windows SDK for .NET 3.5 SP1 (.NET 4.0 won't work).
+-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::
 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 32bit.
 -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
 ------------------------
 Step2 - Install Python
 ----------------------
 Install Python 2.x.y (x = 6 or 7) x86 version (32bit). DO NOT USE A 3.x version.
 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" (32bit version) not "Windows X86-64
+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::
-bit: Just download and install the 64bit version of python.
+-bit: Just download and install the 64-bit version of python.
 Step3 - Install Win32py extensions
 ----------------------------------
 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::
-bit: Download and install the 64bit version.
+-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
 Step4 - Python BIN
 ------------------
 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
 Step5 - Kallithea folder structure
 ----------------------------------
 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
 Step6 - Install virtualenv
 ---------------------------
 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::
  python virtualenv.py C:\Kallithea\Env
 (--no-site-packages is now the default behaviour of virtualenv, no need
 to include it)
 Step7 - Install Kallithea
 -------------------------
 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::
-bit: For 64bit you need to modify the shortcut that is used to start the
+-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
 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.
 Step8 - Configuring Kallithea
 -----------------------------
 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 (ip address, ip
+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 "admin@xxxx.com" (or
 whatever you want)
 If you make some mistake and the script does not end, don't worry, start
 it again.
 Step9 - Running Kallithea
 -------------------------
 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

docs/overview.rst

➞

Show inline comments

@@ new file 100644 @@
 .. _overview:
 =====================
 Installation overview
 =====================
 Some overview and some details that can help understanding the options when
 installing Kallithea.
 Python environment
 ------------------
 **Kallithea** is written entirely in Python_ and requires Python version
 .6 or higher. Python 3.x is currently not supported.
 Given a Python installation, there are different ways of providing the
 environment for running Python applications. Each of them pretty much
 corresponds to a ``site-packages`` directory somewhere where packages can be
 installed.
 Kallithea itself can be run from source or be installed, but even when running
 from source, there are some dependencies that must be installed in the Python
 environment used for running Kallithea.
 - Packages *could* be installed in Python's ``site-packages`` directory ... but
   that would require running pip_ as root and it would be hard to uninstall or
   upgrade and is probably not a good idea unless using a package manager.
 - Packages could also be installed in ``~/.local`` ... but that is probably
   only a good idea if using a dedicated user per application or instance.
 - Finally, it can be installed in a virtualenv_. That is a very lightweight
   "container" where each Kallithea instance can get its own dedicated and
   self-contained virtual environment.
 We recommend using virtualenv for installing Kallithea.
 Installation methods
 --------------------
 Kallithea must be installed on a server. Kallithea is installed in a Python
 environment so it can use packages that are installed there and make itself
 available for other packages.
 Two different cases will pretty much cover the options for how it can be
 installed.
 - The Kallithea source repository can be cloned and used -- it is kept stable and
   can be used in production. The Kallithea maintainers use the development
   branch in production. The advantage of installation from source and regularly
   updating it is that you take advantage of the most recent improvements. Using
   it directly from a DVCS also means that it is easy to track local customizations.
   Running ``setup.py develop`` in the source will use pip to install the
   necessary dependencies in the Python environment and create a
   ``.../site-packages/Kallithea.egg-link`` file there that points at the Kallithea
   source.
 - Kallithea can also be installed from ready-made packages using a package manager.
   The official released versions are available on PyPI_ and can be downloaded and
   installed with all dependencies using ``pip install kallithea``.
   With this method, Kallithea is installed in the Python environment as any
   other package, usually as a ``.../site-packages/Kallithea-X-py2.7.egg/``
   directory with Python files and everything else that is needed.
   (``pip install kallithea`` from a source tree will do pretty much the same
   but build the Kallithea package itself locally instead of downloading it.)
 Web server
 ----------
 Kallithea is (primarily) a WSGI_ application that must be run from a web
 server that serves WSGI applications over HTTP.
 Kallithea itself is not serving HTTP (or HTTPS); that is the web server's
 responsibility. Kallithea does however need to know its own user facing URL
 (protocol, address, port and path) for each HTTP request. Kallithea will
 usually use its own HTML/cookie based authentication but can also be configured
 to use web server authentication.
 There are several web server options:
 - Kallithea uses the Paste_ tool as command line interface. Paste provides
   ``paster serve`` as a convenient way to launch a Python WSGI / web server
   from the command line. That is perfect for development and evaluation.
   Actual use in production might have different requirements and need extra
   work to make it manageable as a scalable system service.
   Paste comes with its own built-in web server but Kallithea defaults to use
   Waitress_. Gunicorn_ is also an option. These web servers have different
   limited feature sets.
   The web server used by ``paster`` is configured in the ``.ini`` file passed
   to it. The entry point for the WSGI application is configured
   in ``setup.py`` as ``kallithea.config.middleware:make_app``.
 - `Apache httpd`_ can serve WSGI applications directly using mod_wsgi_ and a
   simple Python file with the necessary configuration. This is a good option if
   Apache is an option.
 - uWSGI_ is also a full web server with built-in WSGI module.
 - IIS_ can also server WSGI applications directly using isapi-wsgi_.
 - A `reverse HTTP proxy <https://en.wikipedia.org/wiki/Reverse_proxy>`_
   can be put in front of another web server which has WSGI support.
   Such a layered setup can be complex but might in some cases be the right
   option, for example to standardize on one internet-facing web server, to add
   encryption or special authentication or for other security reasons, to
   provide caching of static files, or to provide load balancing or fail-over.
   Nginx_, Varnish_ and HAProxy_ are often used for this purpose, often in front
   of a ``paster`` server that somehow is wrapped as a service.
 The best option depends on what you are familiar with and the requirements for
 performance and stability. Also, keep in mind that Kallithea mainly is serving
 dynamically generated pages from a relatively slow Python process. Kallithea is
 also often used inside organizations with a limited amount of users and thus no
 continuous hammering from the internet.
 .. _Python: http://www.python.org/
 .. _Gunicorn: http://gunicorn.org/
 .. _Waitress: http://waitress.readthedocs.org/en/latest/
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _Paste: http://pythonpaste.org/
 .. _PyPI: https://pypi.python.org/pypi
 .. _Apache httpd: http://httpd.apache.org/
 .. _mod_wsgi: https://code.google.com/p/modwsgi/
 .. _isapi-wsgi: https://github.com/hexdump42/isapi-wsgi
 .. _uWSGI: https://uwsgi-docs.readthedocs.org/en/latest/
 .. _nginx: http://nginx.org/en/
 .. _iis: http://en.wikipedia.org/wiki/Internet_Information_Services
 .. _pip: http://en.wikipedia.org/wiki/Pip_%28package_manager%29
 .. _WSGI: http://en.wikipedia.org/wiki/Web_Server_Gateway_Interface
 .. _pylons: http://www.pylonsproject.org/
 .. _HAProxy: http://www.haproxy.org/
 .. _Varnish: https://www.varnish-cache.org/

docs/setup.rst

➞

Show inline comments

 .. _setup:
 =====
 Setup
 =====
 Setting up Kallithea
 --------------------
 First, you will need to create a Kallithea configuration file. Run the
 following command to do so::
     paster make-config Kallithea my.ini
 This will create the file ``my.ini`` in the current directory. This
-configuration file contains the various settings for Kallithea, e.g.,
 configuration file contains the various settings for Kallithea, e.g.
 proxy port, email settings, usage of static files, cache, Celery
 settings, and logging.
 Next, you need to create the databases used by Kallithea. It is recommended to
 use PostgreSQL or SQLite (default). If you choose a database other than the
 default, ensure you properly adjust the database URL in your ``my.ini``
 configuration file to use this other database. Kallithea currently supports
 PostgreSQL, SQLite and MySQL databases. Create the database by running
 the following command::
     paster setup-db my.ini
 This will prompt you for a "root" path. This "root" path is the location where
 Kallithea will store all of its repositories on the current machine. After
 entering this "root" path ``setup-db`` will also prompt you for a username
 and password for the initial admin account which ``setup-db`` sets
 up for you.
 The setup process can be fully automated, example for lazy::
 The ``setup-db`` values can also be given on the command line.
 Example::
-    paster setup-db my.ini --user=nn --password=secret --email=nn@your.kallithea.server --repos=/srv/repos
+    paster setup-db my.ini --user=nn --password=secret --email=nn@example.org --repos=/srv/repos
 The ``setup-db`` command will create all of the needed tables and an
 The ``setup-db`` command will create all needed tables and an
 admin account. When choosing a root path you can either use a new
 empty location, or a location which already contains existing
 repositories. If you choose a location which contains existing
 repositories Kallithea will add all of the repositories at the chosen
 location to its database.  (Note: make sure you specify the correct
 path to the root).
 .. note:: the given path for Mercurial_ repositories **must** be write
           accessible for the application. It's very important since
           the Kallithea web interface will work without write access,
           but when trying to do a push it will fail with permission
           denied errors unless it has write access.
 You are now ready to use Kallithea. To run it simply execute::
     paster serve my.ini
 - This command runs the Kallithea server. The web app should be available at
   http://127.0.0.1:5000. This ip and port is configurable via the my.ini
   file created in previous step
 - Use the admin account you created above when running ``setup-db``
   to login to the web app.
   http://127.0.0.1:5000. The IP address and port is configurable via the
   configuration file created in the previous step.
 - Log in to Kallithea using the admin account created when running ``setup-db``.
 - The default permissions on each repository is read, and the owner is admin.
   Remember to update these if needed.
 - In the admin panel you can toggle LDAP, anonymous, and permissions
   settings, as well as edit more advanced options on users and
   repositories
   repositories.
 Optionally users can create an ``rcextensions`` package that extends Kallithea
 functionality. To do this simply execute::
 Extensions
 ----------
 Optionally one can create an ``rcextensions`` package that extends Kallithea
 functionality.
 To generate a skeleton extensions package, run::
     paster make-rcext my.ini
 This will create an ``rcextensions`` package in the same place that your ``ini`` file
 lives. With ``rcextensions`` it's possible to add additional mapping for whoosh,
 This will create an ``rcextensions`` package next to the specified ``ini`` file.
 With ``rcextensions`` it's possible to add additional mapping for whoosh,
 stats and add additional code into the push/pull/create/delete repo hooks,
 for example, for sending signals to build-bots such as Jenkins.
 Please see the ``__init__.py`` file inside ``rcextensions`` package
 for example for sending signals to build-bots such as Jenkins.
 See the ``__init__.py`` file inside the generated ``rcextensions`` package
 for more details.
 Using Kallithea with SSH
 ------------------------
 Kallithea currently only hosts repositories using http and https. (The addition
 of ssh hosting is a planned future feature.) However you can easily use ssh in
 parallel with Kallithea. (Repository access via ssh is a standard "out of
 the box" feature of Mercurial_ and you can use this to access any of the
 repositories that Kallithea is hosting. See PublishingRepositories_)
 Kallithea repository structures are kept in directories with the same name
 as the project. When using repository groups, each group is a subdirectory.
 This allows you to easily use ssh for accessing repositories.
 In order to use ssh you need to make sure that your web server and the users'
 login accounts have the correct permissions set on the appropriate directories.
 .. note:: These permissions are independent of any permissions you
           have set up using the Kallithea web interface.
 If your main directory (the same as set in Kallithea settings) is for
 example set to ``/srv/repos`` and the repository you are using is
 named ``kallithea``, then to clone via ssh you should run::
     hg clone ssh://user@server.com//srv/repos/kallithea
 Using other external tools such as mercurial-server_ or using ssh key-based
 authentication is fully supported.
 .. note:: In an advanced setup, in order for your ssh access to use
           the same permissions as set up via the Kallithea web
           interface, you can create an authentication hook to connect
           to the Kallithea db and run check functions for permissions
           against that.
 Setting up Whoosh full text search
 ----------------------------------
 The whoosh index can be built by using the paster
 command ``make-index``. To use ``make-index`` you must specify the configuration
 file that stores the location of the index. You may specify the location of the
 repositories (``--repo-location``).  If not specified, this value is retrieved
 from the Kallithea database.
 It is also possible to specify a comma separated list of
 repositories (``--index-only``) to build index only on chooses repositories
 skipping any other found in repos location
 Kallithea provides full text search of repositories using `Whoosh`__.
 You may optionally pass the option ``-f`` to enable a full index rebuild. Without
 the ``-f`` option, indexing will run always in "incremental" mode.
 .. __: https://pythonhosted.org/Whoosh/
-For an incremental index build use::
+For an incremental index build, run::
     paster make-index my.ini
-For a full index rebuild use::
+For a full index rebuild, run::
     paster make-index my.ini -f
 The ``--repo-location`` option allows the location of the repositories to be overriden;
 usually, the location is retrieved from the Kallithea database.
-Building an index for just selected repositories is possible with such command::
+The ``--index-only`` option can be used to limit the indexed repositories to a comma-separated list::
     paster make-index my.ini --index-only=vcs,kallithea
 To keep your index up-to-date it is necessary to do periodic index builds;
 for this, it is recommended to use a crontab entry. Example::
 In order to do periodic index builds and keep your index always up to
 date, it is recommended to use a crontab entry.  An example entry
 might look like this::
 3  *  *  *  /path/to/virtualenv/bin/paster make-index /path/to/kallithea/my.ini
     /path/to/python/bin/paster make-index /path/to/kallithea/my.ini
 When using incremental mode (the default) whoosh will check the last
 When using incremental mode (the default), Whoosh will check the last
 modification date of each file and add it to be reindexed if a newer file is
 available. The indexing daemon checks for any removed files and removes them
 from index.
 If you want to rebuild the index from scratch, you can use the ``-f`` flag as above,
-or in the admin panel you can check the "build from scratch" flag.
+or in the admin panel you can check the "build from scratch" checkbox.
 Setting up LDAP support
 -----------------------
 Kallithea supports LDAP authentication. In order
 to use LDAP, you have to install the python-ldap_ package. This package is
-available via pypi, so you can install it by running::
+available via PyPI, so you can install it by running::
     pip install python-ldap
 .. note:: ``python-ldap`` requires some libraries to be installed on
           your system, so before installing it check that you have at
           least the ``openldap`` and ``sasl`` libraries.
 LDAP settings are located in the Admin->LDAP section.
 Choose *Admin > Authentication*, click the ``kallithea.lib.auth_modules.auth_ldap`` button
 and then *Save*, to enable the LDAP plugin and configure its settings.
 Here's a typical LDAP setup::
  Connection settings
  Enable LDAP          = checked
  Host                 = host.example.org
  Port                 = 389
  Account              = <account>
  Password             = <password>
  Connection Security  = LDAPS connection
  Certificate Checks   = DEMAND
  Search settings
  Base DN              = CN=users,DC=host,DC=example,DC=org
  LDAP Filter          = (&(objectClass=user)(!(objectClass=computer)))
  LDAP Search Scope    = SUBTREE
  Attribute mappings
  Login Attribute      = uid
  First Name Attribute = firstName
  Last Name Attribute  = lastName
- E-mail Attribute     = mail
+ Email Attribute      = mail
 If your user groups are placed in an Organisation Unit (OU) structure, the Search Settings configuration differs::
  Search settings
  Base DN              = DC=host,DC=example,DC=org
  LDAP Filter          = (&(memberOf=CN=your user group,OU=subunit,OU=unit,DC=host,DC=example,DC=org)(objectClass=user))
  LDAP Search Scope    = SUBTREE
 .. _enable_ldap:
 Enable LDAP : required
     Whether to use LDAP for authenticating users.
 .. _ldap_host:
 Host : required
     LDAP server hostname or IP address. Can be also a comma separated
     list of servers to support LDAP fail-over.
 .. _Port:
 Port : required
 for un-encrypted LDAP, 636 for SSL-encrypted LDAP.
 .. _ldap_account:
 Account : optional
     Only required if the LDAP server does not allow anonymous browsing of
     records.  This should be a special account for record browsing.  This
     will require `LDAP Password`_ below.
 .. _LDAP Password:
 Password : optional
     Only required if the LDAP server does not allow anonymous browsing of
     records.
 .. _Enable LDAPS:
 Connection Security : required
     Defines the connection to LDAP server
     No encryption
         Plain non encrypted connection
     LDAPS connection
         Enable LDAPS connections. It will likely require `Port`_ to be set to
         a different value (standard LDAPS port is 636). When LDAPS is enabled
         then `Certificate Checks`_ is required.
     START_TLS on LDAP connection
         START TLS connection
 .. _Certificate Checks:
 Certificate Checks : optional
     How SSL certificates verification is handled - this is only useful when
+    How SSL certificates verification is handled -- this is only useful when
     `Enable LDAPS`_ is enabled.  Only DEMAND or HARD offer full SSL security
     while the other options are susceptible to man-in-the-middle attacks.  SSL
     certificates can be installed to /etc/openldap/cacerts so that the
     DEMAND or HARD options can be used with self-signed certificates or
     certificates that do not have traceable certificates of authority.
     NEVER
         A serve certificate will never be requested or checked.
     ALLOW
         A server certificate is requested.  Failure to provide a
         certificate or providing a bad certificate will not terminate the
         session.
     TRY
         A server certificate is requested.  Failure to provide a
         certificate does not halt the session; providing a bad certificate
         halts the session.
     DEMAND
         A server certificate is requested and must be provided and
         authenticated for the session to proceed.
     HARD
         The same as DEMAND.
 .. _Base DN:
 Base DN : required
     The Distinguished Name (DN) where searches for users will be performed.
     Searches can be controlled by `LDAP Filter`_ and `LDAP Search Scope`_.
 .. _LDAP Filter:
 LDAP Filter : optional
     A LDAP filter defined by RFC 2254.  This is more useful when `LDAP
     Search Scope`_ is set to SUBTREE.  The filter is useful for limiting
     which LDAP objects are identified as representing Users for
     authentication.  The filter is augmented by `Login Attribute`_ below.
     This can commonly be left blank.
 .. _LDAP Search Scope:
 LDAP Search Scope : required
     This limits how far LDAP will search for a matching object.
     BASE
         Only allows searching of `Base DN`_ and is usually not what you
         want.
     ONELEVEL
         Searches all entries under `Base DN`_, but not Base DN itself.
     SUBTREE
         Searches all entries below `Base DN`_, but not Base DN itself.
         When using SUBTREE `LDAP Filter`_ is useful to limit object
         location.
 .. _Login Attribute:
 Login Attribute : required
     The LDAP record attribute that will be matched as the USERNAME or
     ACCOUNT used to connect to Kallithea.  This will be added to `LDAP
     Filter`_ for locating the User object.  If `LDAP Filter`_ is specified as
     "LDAPFILTER", `Login Attribute`_ is specified as "uid" and the user has
     connected as "jsmith" then the `LDAP Filter`_ will be augmented as below
     ::
         (&(LDAPFILTER)(uid=jsmith))
 .. _ldap_attr_firstname:
 First Name Attribute : required
     The LDAP record attribute which represents the user's first name.
 .. _ldap_attr_lastname:
 Last Name Attribute : required
     The LDAP record attribute which represents the user's last name.
 .. _ldap_attr_email:
 Email Attribute : required
     The LDAP record attribute which represents the user's email address.
 If all data are entered correctly, and python-ldap_ is properly installed
 users should be granted access to Kallithea with LDAP accounts.  At this
 time user information is copied from LDAP into the Kallithea user database.
 This means that updates of an LDAP user object may not be reflected as a
 user update in Kallithea.
 If You have problems with LDAP access and believe You entered correct
 information check out the Kallithea logs, any error messages sent from LDAP
 will be saved there.
 Active Directory
 ''''''''''''''''
 Kallithea can use Microsoft Active Directory for user authentication.  This
 is done through an LDAP or LDAPS connection to Active Directory.  The
 following LDAP configuration settings are typical for using Active
 Directory ::
  Base DN              = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local
  Login Attribute      = sAMAccountName
  First Name Attribute = givenName
  Last Name Attribute  = sn
- E-mail Attribute     = mail
+ Email Attribute     = mail
 All other LDAP settings will likely be site-specific and should be
 appropriately configured.
 Authentication by container or reverse-proxy
 --------------------------------------------
 Kallithea supports delegating the authentication
 of users to its WSGI container, or to a reverse-proxy server through which all
 clients access the application.
 When these authentication methods are enabled in Kallithea, it uses the
-username that the container/proxy (Apache/Nginx/etc) authenticated and doesn't
+username that the container/proxy (Apache or Nginx, etc.) provides and doesn't
 perform the authentication itself. The authorization, however, is still done by
 Kallithea according to its settings.
 When a user logs in for the first time using these authentication methods,
 a matching user account is created in Kallithea with default permissions. An
 administrator can then modify it using Kallithea's admin interface.
 It's also possible for an administrator to create accounts and configure their
 permissions before the user logs in for the first time.
 permissions before the user logs in for the first time, using the :ref:`create-user` API.
 Container-based authentication
 ''''''''''''''''''''''''''''''
 In a container-based authentication setup, Kallithea reads the user name from
 the ``REMOTE_USER`` server variable provided by the WSGI container.
-After setting up your container (see `Apache's WSGI config`_), you'd need
+After setting up your container (see `Apache with mod_wsgi`_), you'll need
 to configure it to require authentication on the location configured for
 Kallithea.
 Proxy pass-through authentication
 '''''''''''''''''''''''''''''''''
 In a proxy pass-through authentication setup, Kallithea reads the user name
 from the ``X-Forwarded-User`` request header, which should be configured to be
 sent by the reverse-proxy server.
 After setting up your proxy solution (see `Apache virtual host reverse proxy example`_,
-`Apache as subdirectory`_ or `Nginx virtual host example`_), you'd need to
+`Apache as subdirectory`_ or `Nginx virtual host example`_), you'll need to
 configure the authentication and add the username in a request header named
 ``X-Forwarded-User``.
 For example, the following config section for Apache sets a subdirectory in a
 reverse-proxy setup with basic auth::
 reverse-proxy setup with basic auth:
 .. code-block:: apache
     <Location /<someprefix> >
       ProxyPass http://127.0.0.1:5000/<someprefix>
       ProxyPassReverse http://127.0.0.1:5000/<someprefix>
     <Location /someprefix>
       ProxyPass http://127.0.0.1:5000/someprefix
       ProxyPassReverse http://127.0.0.1:5000/someprefix
       SetEnvIf X-Url-Scheme https HTTPS=1
       AuthType Basic
       AuthName "Kallithea authentication"
       AuthUserFile /srv/kallithea/.htpasswd
-      require valid-user
+      Require valid-user
       RequestHeader unset X-Forwarded-User
       RewriteEngine On
       RewriteCond %{LA-U:REMOTE_USER} (.+)
       RewriteRule .* - [E=RU:%1]
       RequestHeader set X-Forwarded-User %{RU}e
     </Location>
 .. note::
    If you enable proxy pass-through authentication, make sure your server is
    only accessible through the proxy. Otherwise, any client would be able to
    forge the authentication header and could effectively become authenticated
    using any account of their liking.
 Integration with Issue trackers
 Integration with issue trackers
 -------------------------------
 Kallithea provides a simple integration with issue trackers. It's possible
 to define a regular expression that will fetch an issue id stored in a commit
 messages and replace that with a URL to the issue. To enable this simply
 to define a regular expression that will match an issue ID in commit messages,
 and have that replaced with a URL to the issue. To enable this simply
 uncomment the following variables in the ini file::
     issue_pat = (?:^#|\s#)(\w+)
     issue_server_link = https://myissueserver.com/{repo}/issue/{id}
     issue_prefix = #
 ``issue_pat`` is the regular expression describing which strings in
 commit messages will be treated as issue references. A match group in
 parentheses should be used to specify the actual issue id.
 The default expression matches issues in the format ``#<number>``, e.g., ``#300``.
 Matched issues are replaced with the link specified as
 ``issue_server_link`` ``{id}`` is replaced with issue id, and
 Matched issue references are replaced with the link specified in
 ``issue_server_link``. ``{id}`` is replaced with the issue ID, and
 ``{repo}`` with the repository name.  Since the # is stripped away,
 ``issue_prefix`` is prepended to the link text.  ``issue_prefix`` doesn't
 necessarily need to be ``#``: if you set issue prefix to ``ISSUE-`` this will
 generate a URL in the format::
 generate a URL in the format:
 .. code-block:: html
   <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>
 If needed, more than one pattern can be specified by appending a unique suffix to
 the variables. For example::
     issue_pat_wiki = (?:wiki-)(.+)
     issue_server_link_wiki = https://mywiki.com/{id}
     issue_prefix_wiki = WIKI-
 With these settings, wiki pages can be referenced as wiki-some-id, and every
 such reference will be transformed into::
 such reference will be transformed into:
 .. code-block:: html
   <a href="https://mywiki.com/some-id">WIKI-some-id</a>
 Hook management
 ---------------
 Hooks can be managed in similar way to that used in ``.hgrc`` files.
 To access hooks setting click `advanced setup` in the `Hooks` section
 of Mercurial Settings in Admin.
 To manage hooks, choose *Admin > Settings > Hooks*.
 There are four built in hooks that cannot be changed (only enabled/disabled by
 checkboxes in the previous section).
 To add another custom hook simply fill in the first section with
 ``<name>.<hook_type>`` and the second one with hook path. Example hooks
 The built-in hooks cannot be modified, though they can be enabled or disabled in the *VCS* section.
 To add another custom hook simply fill in the first textbox with
 ``<name>.<hook_type>`` and the second with the hook path. Example hooks
 can be found in ``kallithea.lib.hooks``.
 Changing default encoding
 -------------------------
 By default, Kallithea uses UTF-8 encoding.
 This is configurable as ``default_encoding`` in the .ini file.
 This affects many parts in Kallithea including user names, filenames, and
 encoding of commit messages. In addition Kallithea can detect if the ``chardet``
 library is installed. If ``chardet`` is detected Kallithea will fallback to it
 when there are encode/decode errors.
 Celery configuration
 --------------------
 Kallithea can use the distributed task queue system Celery_ to run tasks like
-cloning repositories or sending mails.
+cloning repositories or sending emails.
 Kallithea will in most setups work perfectly fine out of the box (without
 Celery), executing all tasks in the web server process. Some tasks can however
 take some time to run and it can be better to run such tasks asynchronously in
 a separate process so the web server can focus on serving web requests.
 For installation and configuration of Celery, see the `Celery documentation`_.
 Note that Celery requires a message broker service like RabbitMQ_ (recommended)
 or Redis_.
 The use of Celery is configured in the Kallithea ini configuration file.
 To enable it, simply set::
   use_celery = true
 and add or change the ``celery.*`` and ``broker.*`` configuration variables.
 Remember that the ini files use the format with '.' and not with '_' like
 Celery. So for example setting `BROKER_HOST` in Celery means setting
 `broker.host` in the configuration file.
 To start the Celery process, run::
  paster celeryd <configfile.ini>
 .. note::
    Make sure you run this command from the same virtualenv, and with the same
    user that Kallithea runs.
 HTTPS support
 -------------
 Kallithea will by default generate URLs based on the WSGI environment.
 Alternatively, you can use some special configuration settings to control
 directly which scheme/protocol Kallithea will use when generating URLs:
 - With ``https_fixup = true``, the scheme will be taken from the ``HTTP_X_URL_SCHEME``,
   ``HTTP_X_FORWARDED_SCHEME`` or ``HTTP_X_FORWARDED_PROTO HTTP`` header (default ``http``).
 - With ``https_fixup = true``, the scheme will be taken from the
   ``X-Url-Scheme``, ``X-Forwarded-Scheme`` or ``X-Forwarded-Proto`` HTTP header
   (default ``http``).
 - With ``force_https = true`` the default will be ``https``.
 - With ``use_htsts = true``, it will set ``Strict-Transport-Security`` when using https.
 - With ``use_htsts = true``, Kallithea will set ``Strict-Transport-Security`` when using https.
 Nginx virtual host example
 --------------------------
 Sample config for nginx using proxy::
 Sample config for Nginx using proxy:
 .. code-block:: nginx
     upstream kallithea {
         server 127.0.0.1:5000;
         # add more instances for load balancing
         #server 127.0.0.1:5001;
         #server 127.0.0.1:5002;
+    }
     ## gist alias
     server {
        listen          443;
        server_name     gist.myserver.com;
        access_log      /var/log/nginx/gist.access.log;
        error_log       /var/log/nginx/gist.error.log;
        ssl on;
        ssl_certificate     gist.your.kallithea.server.crt;
        ssl_certificate_key gist.your.kallithea.server.key;
        ssl_session_timeout 5m;
        ssl_protocols SSLv3 TLSv1;
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
        rewrite ^/(.+)$ https://your.kallithea.server/_admin/gists/$1;
        rewrite (.*)    https://your.kallithea.server/_admin/gists;
+    }
     server {
        listen          443;
        server_name     your.kallithea.server;
        access_log      /var/log/nginx/kallithea.access.log;
        error_log       /var/log/nginx/kallithea.error.log;
        ssl on;
        ssl_certificate     your.kallithea.server.crt;
        ssl_certificate_key your.kallithea.server.key;
        ssl_session_timeout 5m;
        ssl_protocols SSLv3 TLSv1;
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
        ## uncomment root directive if you want to serve static files by nginx
        ## requires static_files = false in .ini file
        #root /path/to/installation/kallithea/public;
        include         /etc/nginx/proxy.conf;
        location / {
             try_files $uri @kallithea;
+       }
        location @kallithea {
             proxy_pass      http://kallithea;
+       }
+    }
 Here's the proxy.conf. It's tuned so it will not timeout on long
 pushes or large pushes::
     proxy_redirect              off;
     proxy_set_header            Host $host;
     ## needed for container auth
     #proxy_set_header            REMOTE_USER $remote_user;
     #proxy_set_header            X-Forwarded-User $remote_user;
     proxy_set_header            X-Url-Scheme $scheme;
     proxy_set_header            X-Host $http_host;
     proxy_set_header            X-Real-IP $remote_addr;
     proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header            Proxy-host $proxy_host;
     proxy_buffering             off;
     proxy_connect_timeout       7200;
     proxy_send_timeout          7200;
     proxy_read_timeout          7200;
     proxy_buffers               8 32k;
     client_max_body_size        1024m;
     client_body_buffer_size     128k;
     large_client_header_buffers 8 64k;
 Apache virtual host reverse proxy example
 -----------------------------------------
 Here is a sample configuration file for apache using proxy::
 Here is a sample configuration file for Apache using proxy:
 .. code-block:: apache
     <VirtualHost *:80>
             ServerName hg.myserver.com
             ServerAlias hg.myserver.com
             <Proxy *>
               Order allow,deny
               Allow from all
               # For Apache 2.4 and later:
               Require all granted
               # For Apache 2.2 and earlier, instead use:
               # Order allow,deny
               # Allow from all
             </Proxy>
             #important !
             #Directive to properly generate url (clone url) for pylons
             ProxyPreserveHost On
             #kallithea instance
             ProxyPass / http://127.0.0.1:5000/
             ProxyPassReverse / http://127.0.0.1:5000/
             #to enable https use line below
             #SetEnvIf X-Url-Scheme https HTTPS=1
     </VirtualHost>
 Additional tutorial
 http://pylonsbook.com/en/1.1/deployment.html#using-apache-to-proxy-requests-to-pylons
 Apache as subdirectory
 ----------------------
 Apache subdirectory part::
 Apache subdirectory part:
 .. code-block:: apache
     <Location /<someprefix> >
       ProxyPass http://127.0.0.1:5000/<someprefix>
       ProxyPassReverse http://127.0.0.1:5000/<someprefix>
       SetEnvIf X-Url-Scheme https HTTPS=1
     </Location>
 Besides the regular apache setup you will need to add the following line
 into ``[app:main]`` section of your .ini file::
     filter-with = proxy-prefix
 Add the following at the end of the .ini file::
     [filter:proxy-prefix]
     use = egg:PasteDeploy#prefix
     prefix = /<someprefix>
 then change ``<someprefix>`` into your chosen prefix
 Apache's WSGI config
 Apache with mod_wsgi
 --------------------
 Alternatively, Kallithea can be set up with Apache under mod_wsgi. For
 that, you'll need to:
 - Install mod_wsgi. If using a Debian-based distro, you can install
   the package libapache2-mod-wsgi::
     aptitude install libapache2-mod-wsgi
 - Enable mod_wsgi::
     a2enmod wsgi
 - Create a wsgi dispatch script, like the one below. Make sure you
   check that the paths correctly point to where you installed Kallithea
   and its Python Virtual Environment.
 - Enable the ``WSGIScriptAlias`` directive for the WSGI dispatch script,
   as in the following example. Once again, check the paths are
   correctly specified.
 Here is a sample excerpt from an Apache Virtual Host configuration file::
 Here is a sample excerpt from an Apache Virtual Host configuration file:
 .. code-block:: apache
     WSGIDaemonProcess kallithea \
         processes=1 threads=4 \
         python-path=/srv/kallithea/pyenv/lib/python2.7/site-packages
     WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
     WSGIPassAuthorization On
 Or if using a dispatcher WSGI script with proper virtualenv activation::
 Or if using a dispatcher WSGI script with proper virtualenv activation:
 .. code-block:: apache
     WSGIDaemonProcess kallithea processes=1 threads=4
     WSGIScriptAlias / /srv/kallithea/dispatch.wsgi
     WSGIPassAuthorization On
 .. note::
    When running apache as root, please make sure it doesn't run Kallithea as
    root, for examply by adding: ``user=www-data group=www-data`` to the configuration.
 .. note::
    If running Kallithea in multiprocess mode,
    make sure you set ``instance_id = *`` in the configuration so each process
    gets it's own cache invalidation key.
 Example WSGI dispatch script:
-Example WSGI dispatch script::
+.. code-block:: python
     import os
     os.environ["HGENCODING"] = "UTF-8"
     os.environ['PYTHON_EGG_CACHE'] = '/srv/kallithea/.egg-cache'
     # sometimes it's needed to set the curent dir
     os.chdir('/srv/kallithea/')
     import site
     site.addsitedir("/srv/kallithea/pyenv/lib/python2.7/site-packages")
     from paste.deploy import loadapp
     from paste.script.util.logging_config import fileConfig
     fileConfig('/srv/kallithea/my.ini')
     application = loadapp('config:/srv/kallithea/my.ini')
 Or using proper virtualenv activation::
 Or using proper virtualenv activation:
 .. code-block:: python
     activate_this = '/srv/kallithea/venv/bin/activate_this.py'
     execfile(activate_this,dict(__file__=activate_this))
+    execfile(activate_this, dict(__file__=activate_this))
     import os
     os.environ['HOME'] = '/srv/kallithea'
     ini = '/srv/kallithea/kallithea.ini'
     from paste.script.util.logging_config import fileConfig
     fileConfig(ini)
     from paste.deploy import loadapp
     application = loadapp('config:' + ini)
 Other configuration files
 -------------------------
 Some example init.d scripts can be found in the ``init.d`` directory:
 https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
 A number of `example init.d scripts`__ can be found in
 the ``init.d`` directory of the Kallithea source.
 .. __: https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _Mercurial: http://mercurial.selenic.com/
 .. _Celery: http://celeryproject.org/
 .. _Celery documentation: http://docs.celeryproject.org/en/latest/getting-started/index.html
 .. _RabbitMQ: http://www.rabbitmq.com/
 .. _Redis: http://redis.io/
 .. _python-ldap: http://www.python-ldap.org/
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories

docs/theme/nature/layout.html

➞

Show inline comments

 {% extends "basic/layout.html" %}
 {% block sidebarlogo %}
 <div style="text-align:center;margin:10px;padding:20px;background:white">
   <img src="{{pathto('_static/kallithea-logo.svg',1)}}"/>
 <div style="text-align:center;margin:30px 0;">
   <img src="{{pathto('_static/kallithea-logo.svg',1)}}" width="200px"/>
 </div>
 <h3>Support Kallithea development</h3>
 <div style="text-align:center">
 <form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
 <input type="hidden" name="cmd" value="_s-xclick">
 <input type="hidden" name="hosted_button_id" value="EYXFS3SQPHYUL">
-<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
+<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal &ndash; The safer, easier way to pay online!">
 <img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
 </form>
     <div style="padding:5px">
      <a href="https://flattr.com/thing/922714/Donate-to-Software-Freedom-Conservancy" target="_blank">
      <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>
     </div>
 </div>
 {% endblock %}}

docs/theme/nature/static/nature.css_t

➞

Show inline comments

 /**
  * Sphinx stylesheet -- default theme
  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  */
 @import url("basic.css");
 /* -- page layout ----------------------------------------------------------- */
 body {
     font-family: Arial, sans-serif;
     font-size: 100%;
     background-color: #111;
     color: #555;
     margin: 0;
     padding: 0;
+}
 div.documentwrapper {
     float: left;
     width: 100%;
+}
 div.bodywrapper {
     margin: 0 0 0 230px;
+}
 hr{
     border: 1px solid #B1B4B6;
+}
 div.document {
     background-color: #eee;
+}
 div.body {
     background-color: #ffffff;
     color: #3E4349;
     padding: 0 30px 30px 30px;
     font-size: 0.8em;
+}
 div.footer {
     color: #555;
     width: 100%;
     padding: 13px 0;
     text-align: center;
     font-size: 75%;
+}
 div.footer a {
     color: #444;
     text-decoration: underline;
+}
 div.related {
     background-color: #577632;
     line-height: 32px;
     color: #fff;
     text-shadow: 0px 1px 0 #444;
     font-size: 0.80em;
+}
 div.related a {
     color: #E2F3CC;
+}
 div.sphinxsidebar {
     font-size: 0.75em;
     line-height: 1.5em;
+}
 div.sphinxsidebarwrapper{
     padding: 20px 0;
+}
 div.sphinxsidebar h3,
 div.sphinxsidebar h4 {
     font-family: Arial, sans-serif;
     color: #222;
     font-size: 1.2em;
     font-weight: normal;
     margin: 0;
     padding: 5px 10px;
     background-color: #ddd;
     text-shadow: 1px 1px 0 white
+}
 div.sphinxsidebar h4{
     font-size: 1.1em;
+}
 div.sphinxsidebar h3 a {
     color: #444;
+}
 div.sphinxsidebar p {
     color: #888;
     padding: 5px 20px;
+}
 div.sphinxsidebar p.topless {
+}
 div.sphinxsidebar ul {
     margin: 10px 20px;
     padding: 0;
     color: #000;
+}
 div.sphinxsidebar a {
     color: #444;
+}
 div.sphinxsidebar input {
     border: 1px solid #ccc;
     font-family: sans-serif;
     font-size: 1em;
+}
 div.sphinxsidebar input[type=text]{
     margin-left: 20px;
+}
 div.sphinxsidebar input[type=image] {
     border: 0;
+}
 /* -- body styles ----------------------------------------------------------- */
 a {
     color: #005B81;
     text-decoration: none;
+}
 a:hover {
     color: #E32E00;
     text-decoration: underline;
+}
 div.body h1,
 div.body h2,
 div.body h3,
 div.body h4,
 div.body h5,
 div.body h6 {
     font-family: Arial, sans-serif;
     background-color: #BED4EB;
     font-weight: normal;
     color: #212224;
     margin: 30px 0px 10px 0px;
     padding: 5px 0 5px 10px;
     text-shadow: 0px 1px 0 white
+}
 div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
 div.body h2 { font-size: 150%; background-color: #C8D5E3; }
 div.body h3 { font-size: 120%; background-color: #D8DEE3; }
 div.body h4 { font-size: 110%; background-color: #D8DEE3; }
 div.body h5 { font-size: 100%; background-color: #D8DEE3; }
 div.body h6 { font-size: 100%; background-color: #D8DEE3; }
 a.headerlink {
     color: #c60f0f;
     font-size: 0.8em;
     padding: 0 4px 0 4px;
     text-decoration: none;
+}
 a.headerlink:hover {
     background-color: #c60f0f;
     color: white;
+}
 div.body p, div.body dd, div.body li {
     line-height: 1.5em;
+}
 div.admonition p.admonition-title + p {
     display: inline;
+}
 div.highlight{
     background-color: white;
+}
 div.note {
     background-color: #eee;
     border: 1px solid #ccc;
+}
 div.seealso {
     background-color: #ffc;
     border: 1px solid #ff6;
+}
 div.topic {
     background-color: #eee;
+}
 div.warning {
     background-color: #ffe4e4;
     border: 1px solid #f66;
+}
 p.admonition-title {
     display: inline;
+}
 p.admonition-title:after {
     content: ":";
+}
 pre {
     padding: 10px;
     background-color: White;
     color: #222;
     line-height: 1.2em;
     border: 1px solid #C6C9CB;
     font-size: 1.2em;
     margin: 1.5em 0 1.5em 0;
     -webkit-box-shadow: 1px 1px 1px #d8d8d8;
     -moz-box-shadow: 1px 1px 1px #d8d8d8;
     box-shadow: 1px 1px 1px #d8d8d8;
+}
 tt {
     background-color: #ecf0f3;
     color: #222;
     padding: 1px 2px;
     font-size: 1.2em;
     font-family: monospace;
+}

docs/usage/backup.rst

➞

Show inline comments

 .. _backup:
 ====================
 Backing up Kallithea
 ====================
 Settings
 --------
 Just copy your .ini file, it contains all Kallithea settings.
 Whoosh index
 ------------
 The Whoosh index is located in the ``data/index`` directory where you installed
 Kallithea, i.e., the same place where the ini file is located
 Database
 --------
 When using sqlite just copy kallithea.db.
 Any other database engine requires a manual backup operation.
 A database backup will contain all gathered statistics.

docs/usage/debugging.rst

➞

Show inline comments

 .. _debugging:
 ===================
 Debugging Kallithea
 ===================
 If you encounter problems with Kallithea, here are some instructions
 on how to debug them.
 .. note:: First make sure you're using the latest version available.
 Enable detailed debug
 ---------------------
 Kallithea uses the standard Python ``logging`` module to log its output.
 By default only loggers with ``INFO`` level are displayed. To enable full output
 change ``level = DEBUG`` for all logging handlers in the currently used .ini file.
 This change will allow you to see much more detailed output in the log file or
 console. This generally helps a lot to track issues.
 Enable interactive debug mode
 -----------------------------
 To enable interactive debug mode simply comment out ``set debug = false`` in
 the .ini file. This will trigger an interactive debugger each time
 there is an error in the browser, or send a http link if an error occured in the backend. This
 is a great tool for fast debugging as you get a handy Python console right
 in the web view.
 .. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console
              can be a serious security threat to your system.

docs/usage/email.rst

➞

Show inline comments

@@ new file 100644 @@
 .. _email:
 ==============
 Email settings
 ==============
 The Kallithea configuration file has several email related settings. When
 these contain correct values, Kallithea will send email in the situations
 described below. If the email configuration is not correct so that emails
 cannot be sent, all mails will show up in the log output.
 Before any email can be sent, an SMTP server has to be configured using the
 configuration file setting ``smtp_server``. If required for that server, specify
 a username (``smtp_username``) and password (``smtp_password``), a non-standard
 port (``smtp_port``), encryption settings (``smtp_use_tls`` or ``smtp_use_ssl``)
 and/or specific authentication parameters (``smtp_auth``).
 Application emails
 ------------------
 Kallithea sends an email to `users` on several occasions:
 - when comments are given on one of their changesets
 - when comments are given on changesets they are reviewer on or on which they
   commented regardless
 - when they are invited as reviewer in pull requests
 - when they request a password reset
 Kallithea sends an email to all `administrators` upon new account registration.
 Administrators are users with the ``Admin`` flag set on the *Admin > Users*
 page.
 When Kallithea wants to send an email but due to an error cannot correctly
 determine the intended recipients, the administrators and the addresses
 specified in ``email_to`` in the configuration file are used as fallback.
 Recipients will see these emails originating from the sender specified in the
 ``app_email_from`` setting in the configuration file. This setting can either
 contain only an email address, like `kallithea-noreply@example.com`, or both
 a name and an address in the following format: `Kallithea
 <kallithea-noreply@example.com>`. However, if the email is sent due to an
 action of a particular user, for example when a comment is given or a pull
 request created, the name of that user will be combined with the email address
 specified in ``app_email_from`` to form the sender (and any name part in that
 configuration setting disregarded).
 The subject of these emails can optionally be prefixed with the value of
 ``email_prefix`` in the configuration file.
 Error emails
 ------------
 When an exception occurs in Kallithea -- and unless interactive debugging is
 enabled using ``set debug = true`` in the ``[app:main]`` section of the
 configuration file -- an email with exception details is sent by WebError_'s
 ``ErrorMiddleware`` to the addresses specified in ``email_to`` in the
 configuration file.
 Recipients will see these emails originating from the sender specified in the
 ``error_email_from`` setting in the configuration file. This setting can either
 contain only an email address, like `kallithea-noreply@example.com`, or both
 a name and an address in the following format: `Kallithea Errors
 <kallithea-noreply@example.com>`.
 *Note:* The WebError_ package does not respect ``smtp_port`` and assumes the
 standard SMTP port (25). If you have a remote SMTP server with a different port,
 you could set up a local forwarding SMTP server on port 25.
 References
 ----------
 - `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_
 - `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_
 .. _WebError: https://pypi.python.org/pypi/WebError

docs/usage/general.rst

➞

Show inline comments

 .. _general:
 =======================
 General Kallithea usage
 =======================
-Repository deleting
+Repository deletion
 -------------------
 Currently when an admin or owner deletes a repository, Kallithea does
 not physically delete said repository from the filesystem, but instead
 renames it in a special way so that it is not possible to push, clone
 or access the repository.
-There is a special command for cleaning up such archived repos::
+There is a special command for cleaning up such archived repositories::
     paster cleanup-repos --older-than=30d my.ini
 This command scans for archived repositories that are older than
 days, displays them, and asks if you want to delete them (unless given
 the ``--dont-ask`` flag). If you host a large amount of repositories with
 forks that are constantly being deleted, it is recommended that you run this
 command via crontab.
 It is worth noting that even if someone is given administrative access to
 Kallithea and deletes a repository, you can easily restore such an action by
 renaming the repository directory, removing the ``rm__<date>`` prefix.
 File view: follow current branch
 --------------------------------
 In the file view, left and right arrows allow to jump to the previous and next
 revision. Depending on the way revisions were created in the repository, this
 could jump to a different branch.  When the checkbox ``Follow current branch``
 is checked, these arrows will only jump to revisions on the same branch as the
 currently visible revision.  So for example, if someone is viewing files in the
 ``beta`` branch and marks the `Follow current branch` checkbox, the < and >
 arrows will only show revisions on the ``beta`` branch.
 Changelog features
 ------------------
 The core feature of a repository's ``changelog`` page is to show the revisions
 in a repository. However, there are several other features available from the
 changelog.
 Branch filter
   By default, the changelog shows revisions from all branches in the
   repository. Use the branch filter to restrict to a given branch.
 Viewing a changeset
   A particular changeset can be opened by clicking on either the changeset
   hash or the commit message, or by ticking the checkbox and clicking the
   ``Show selected changeset`` button at the top.
 Viewing all changes between two changesets
   To get a list of all changesets between two selected changesets, along with
   the changes in each one of them, tick the checkboxes of the first and
   last changeset in the desired range and click the ``Show selected changesets``
   button at the top. You can only show the range between the first and last
   checkbox (no cherry-picking).
   From that page, you can proceed to viewing the overall delta between the
   selected changesets, by clicking the ``Compare revisions`` button.
 Creating a pull request
   You can create a new pull request for the changes of a particular changeset
   (and its ancestors) by selecting it and clicking the ``Open new pull request
   for selected changesets`` button.
 Permanent repository URLs
 -------------------------
 Due to the complicated nature of repository grouping, URLs of repositories
 can often change. For example, a repository originally accessible from::
-  http://server.com/repo_name
+  http://example.com/repo_name
 would get a new URL after moving it to test_group::
-  http://server.com/test_group/repo_name
+  http://example.com/test_group/repo_name
 Such moving of a repository to a group can be an issue for build systems and
 other scripts where the repository paths are hardcoded. To mitigate this,
 Kallithea provides permanent URLs using the repository ID prefixed with an
 underscore. In all Kallithea URLs, for example those for the changelog and the
 file view, a repository name can be replaced by this ``_ID`` string. Since IDs
 are always the same, moving the repository to a different group will not affect
 such URLs.
 In the example, the repository could also be accessible as::
-  http://server.com/_<ID>
+  http://example.com/_<ID>
 The ID of a given repository can be shown from the repository ``Summary`` page,
 by selecting the ``Show by ID`` button next to ``Clone URL``.
 E-mail notifications
 --------------------
 When the administrator correctly specified the e-mail settings in the Kallithea
 configuration file, Kallithea will send e-mails on user registration and when
 Email notifications
 -------------------
 With email settings properly configured in the Kallithea
 configuration file, Kallithea will send emails on user registration and when
 errors occur.
-Mails are also sent for comments on changesets. In this case, an e-mail is sent
+Emails are also sent for comments on changesets. In this case, an email is sent
 to the committer of the changeset (if known to Kallithea), to all reviewers of
 the pull request (if applicable) and to all people mentioned in the comment
 using @mention notation.
 Trending source files
 ---------------------
 Trending source files are calculated based on a predefined dictionary of known
 types and extensions. If an extension is missing or you would like to scan
 custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP``
 dictionary located in ``kallithea/config/conf.py`` with new types.
 Cloning remote repositories
 ---------------------------
 Kallithea has the ability to clone repositories from given remote locations.
 Currently it supports the following options:
 - hg  -> hg clone
 - svn -> hg clone
 - git -> git clone
 .. note:: svn -> hg cloning requires the ``hgsubversion`` library to be
    installed.
 If you need to clone repositories that are protected via basic authentication,
 you can pass the credentials in the URL, e.g.
 ``http://user:passw@remote.server/repo``. Kallithea will then try to login and
 clone using the given credentials. Please note that the given credentials will
 be stored as plaintext inside the database. However, the authentication
 information will not be shown in the clone URL on the summary page.
 Specific features configurable in the Admin settings
 ----------------------------------------------------
 In general, the Admin settings should be self-explanatory and will not be
 described in more detail in this documentation. However, there are a few
 features that merit further explanation.
 Repository extra fields
 ~~~~~~~~~~~~~~~~~~~~~~~
 In the `Visual` tab, there is an option `Use repository extra
 fields`, which allows to set custom fields for each repository in the system.
 Each new field consists of 3 attributes: ``field key``, ``field label``,
 ``field description``.
 In the *Visual* tab, there is an option "Use repository extra
 fields", which allows to set custom fields for each repository in the system.
 Once enabled site-wide, the custom fields can be edited per-repository under
 *Options* | *Settings* | *Extra Fields*.
 Example usage of such fields would be to define company-specific information
 into repositories, e.g., defining a ``repo_manager`` key that would give info
 about a manager of each repository.  There's no limit for adding custom fields.
 Newly created fields are accessible via the API.
-Meta-Tagging
+Meta tagging
 ~~~~~~~~~~~~
 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea
 to turn certain meta-tags, detected in repository and repository group
 descriptions, into colored tags. Currently recognised tags are::
 In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea
 to turn certain text fragments in repository and repository group
 descriptions into colored tags. Currently recognised tags are::
     [featured]
     [stale]
     [dead]
     [lang => lang]
     [license => License]
     [requires => Repo]
     [recommends => Repo]
     [see => URI]

docs/usage/locking.rst

➞

Show inline comments

 .. _locking:
 ==================
 Repository locking
 ==================
-Kallithea has a ``repository locking`` feature, disabled by default. When
+Kallithea has a *repository locking* feature, disabled by default. When
 enabled, every initial clone and every pull gives users (with write permission)
 the exclusive right to do a push.
 When repository locking is enabled, repositories get a ``locked`` state that
 can be true or false.  The hg/git commands ``hg/git clone``, ``hg/git pull``,
 When repository locking is enabled, repositories get a ``locked`` flag.
 The hg/git commands ``hg/git clone``, ``hg/git pull``,
 and ``hg/git push`` influence this state:
-- A ``clone`` or ``pull`` action on the repository locks it (``locked=true``)
+- A ``clone`` or ``pull`` action locks the target repository
   if the user has write/admin permissions on this repository.
 - Kallithea will remember the user who locked the repository so only this
-  specific user can unlock the repo (``locked=false``) by performing a ``push``
   specific user can unlock the repo by performing a ``push``
   command.
 - Every other command on a locked repository from this user and every command
   from any other user will result in an HTTP return code 423 (Locked).
-  Additionally, the HTTP error includes the <user> that locked the repository
+  Additionally, the HTTP error will mention the user that locked the repository
   (e.g., “repository <repo> locked by user <user>”).
 Each repository can be manually unlocked by an administrator from the
 repository settings menu.

docs/usage/performance.rst

➞

Show inline comments

 .. _performance:
 ================================
-Optimizing Kallithea Performance
+Optimizing Kallithea performance
 ================================
 When serving a large amount of big repositories, Kallithea can start
 performing slower than expected. Because of the demanding nature of handling large
 amounts of data from version control systems, here are some tips on how to get
 the best performance.
 * Kallithea will perform better on machines with faster disks (SSD/SAN). It's
   more important to have a faster disk than a faster CPU.
 * Kallithea is often I/O bound, and hence a fast disk (SSD/SAN) is
   usually more important than a fast CPU.
-* Slowness on initial page can be easily fixed by grouping repositories, and/or
+* Sluggish loading of the front page can easily be fixed by grouping repositories or by
   increasing cache size (see below). This includes using the lightweight dashboard
   option and ``vcs_full_cache`` setting in .ini file
   option and ``vcs_full_cache`` setting in .ini file.
 Follow these few steps to improve performance of Kallithea system.
 . Increase cache
     In the .ini file::
     Tweak beaker cache settings in the ini file. The actual effect of that
     is questionable.
-     beaker.cache.sql_cache_long.expire=3600 <-- set this to higher number
+. Switch from SQLite to PostgreSQL or MySQL
     This option affects the cache expiration time for the main
     page. Having several hundreds of repositories on main page can
     sometimes make the system behave slowly when the cache expires for
     all of them. Increasing the ``expire`` option to a day (86400) or a
     week (604800) will improve general response times for the main
     page. Kallithea has an intelligent cache expiration system and it
     will expire the cache for repositories that have been changed.
 . Switch from sqlite to postgres or mysql
     sqlite is a good option when having a small load on the system. But due to
     locking issues with sqlite, it is not recommended to use it for larger
     deployments. Switching to mysql or postgres will result in an immediate
     performance increase.
     SQLite is a good option when having a small load on the system. But due to
     locking issues with SQLite, it is not recommended to use it for larger
     deployments. Switching to MySQL or PostgreSQL will result in an immediate
     performance increase. A tool like SQLAlchemyGrate_ can be used for
     migrating to another database platform.
 . Scale Kallithea horizontally
     Scaling horizontally can give huge performance increases when dealing with
     large traffic (large amount of users, CI servers etc). Kallithea can be
     Scaling horizontally can give huge performance benefits when dealing with
     large amounts of traffic (many users, CI servers, etc.). Kallithea can be
     scaled horizontally on one (recommended) or multiple machines. In order
     to scale horizontally you need to do the following:
     - Each instance needs its own .ini file and unique ``instance_id`` set.
     - Each instance's ``data`` storage needs to be configured to be stored on a
       shared disk storage, preferably together with repositories. This ``data``
       dir contains template caches, sessions, whoosh index and is used for
       task locking (so it is safe across multiple instances). Set the
       ``cache_dir``, ``index_dir``, ``beaker.cache.data_dir``, ``beaker.cache.lock_dir``
       variables in each .ini file to a shared location across Kallithea instances
     - If celery is used each instance should run a separate Celery instance, but
       the message broker should be common to all of them (e.g.,  one
       shared RabbitMQ server)
     - Load balance using round robin or IP hash, recommended is writing LB rules
       that will separate regular user traffic from automated processes like CI
       servers or build bots.
 .. _SQLAlchemyGrate: https://github.com/shazow/sqlalchemygrate

docs/usage/statistics.rst

➞

Show inline comments

 .. _statistics:
 =====================
 Repository statistics
 =====================
-Kallithea has a ``repository statistics`` feature, disabled by default. When
+Kallithea has a *repository statistics* feature, disabled by default. When
 enabled, the amount of commits per committer is visualized in a timeline. This
 feature can be enabled using the ``Enable statistics`` checkbox on the
 repository ``Settings`` page.
 The statistics system makes heavy demands on the server resources, so
 in order to keep a balance between usability and performance, statistics are
 cached inside the database and gathered incrementally.
 When Celery is disabled:
   On each first visit to the summary page a set of 250 commits are parsed and
   added to the statistics cache. This incremental gathering also happens on each
   visit to the statistics page, until all commits are fetched.
   Statistics are kept cached until additional commits are added to the
   repository. In such a case Kallithea will only fetch the new commits when
   updating its statistics cache.
 When Celery is enabled:
   On the first visit to the summary page, Kallithea will create tasks that will
   execute on Celery workers. These tasks will gather all of the statistics until
   all commits are parsed. Each task parses 250 commits, then launches a new
   task.

docs/usage/troubleshooting.rst

➞

Show inline comments

 .. _troubleshooting:
 ===============
 Troubleshooting
 ===============
 :Q: **Missing static files?**
 :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:
    ``/home/my-virtual-python/lib/python2.7/site-packages/kallithea/public``
+|
 :Q: **Can't install celery/rabbitmq?**
 :A: Don't worry. Kallithea works without them, too. No extra setup is required.
     Try out the great Celery docs for further help.
+|
 :Q: **Long lasting push timeouts?**
 :A: Make sure you set a longer timeout in your proxy/fcgi settings. Timeouts
     are caused by the http server and not Kallithea.
+|
 :Q: **Large pushes timeouts?**
 :A: Make sure you set a proper ``max_body_size`` for the http server. Very often
     Apache, Nginx, or other http servers kill the connection due to to large
     body.
+|
 :Q: **Apache doesn't pass basicAuth on pull/push?**
 :A: Make sure you added ``WSGIPassAuthorization true``.
+|
 :Q: **Git fails on push/pull?**
 :A: Make sure you're using a WSGI http server that can handle chunked encoding
     such as ``waitress`` or ``gunicorn``.
+|
 :Q: **How can I use hooks in Kallithea?**
 :A: It's easy if they are Python hooks: just use advanced link in
     hooks section in Admin panel, that works only for Mercurial. If
     you want to use Git hooks, just install th proper one in the repository,
     e.g., create a file `/gitrepo/hooks/pre-receive`. You can also use
     Kallithea-extensions to connect to callback hooks, for both Git
     and Mercurial.
+|
 :Q: **Kallithea is slow for me, how can I make it faster?**
 :A: See the :ref:`performance` section.
+|
 :Q: **UnicodeDecodeError on Apache mod_wsgi**
 :A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror.
+|
 :Q: **Requests hanging on Windows**
 :A: Please try out with disabled Antivirus software, there are some known problems with Eset Anitivirus. Make sure
     you have installed the latest Windows patches (especially KB2789397).
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
 .. _rabbitmq: http://www.rabbitmq.com/
 .. _python-ldap: http://www.python-ldap.org/

docs/usage/vcs_support.rst

➞

Show inline comments

 .. _vcs_support:
 ===============================
 Version control systems support
 ===============================
 Kallithea supports Git and Mercurial repositories out-of-the-box.
 For Git, you do need the ``git`` command line client installed on the server.
 You can always disable Git or Mercurial support by editing the
 file ``kallithea/__init__.py`` and commenting out the backend.
 .. code-block:: python
    BACKENDS = {
        'hg': 'Mercurial repository',
        #'git': 'Git repository',
+   }
 Git support
 -----------
 Web server with chunked encoding
 ````````````````````````````````
 Large Git pushes require an HTTP server with support for
 chunked encoding for POST. The Python web servers waitress_ and
 gunicorn_ (Linux only) can be used. By default, Kallithea uses
 waitress_ for `paster serve` instead of the built-in `paste` WSGI
 server.
-The default paste server is controlled in the .ini file::
+The paster server is controlled in the .ini file::
     use = egg:waitress#main
 or::
     use = egg:gunicorn#main
 Also make sure to comment out the following options::
     threadpool_workers =
     threadpool_max_requests =
     use_threadpool =
 Mercurial support
 -----------------
 Working with Mercurial subrepositories
 ``````````````````````````````````````
 This section explains how to use Mercurial subrepositories_ in Kallithea.
 Example usage::
     ## init a simple repo
     hg init mainrepo
     cd mainrepo
     echo "file" > file
     hg add file
     hg ci --message "initial file"
     # clone subrepo we want to add from Kallithea
     hg clone http://kallithea.local/subrepo
     ## specify URL to existing repo in Kallithea as subrepository path
     echo "subrepo = http://kallithea.local/subrepo" > .hgsub
     hg add .hgsub
     hg ci --message "added remote subrepo"
 In the file list of a clone of ``mainrepo`` you will see a connected
 subrepository at the revision it was cloned with. Clicking on the
 subrepository link sends you to the proper repository in Kallithea.
 Cloning ``mainrepo`` will also clone the attached subrepository.
 Next we can edit the subrepository data, and push back to Kallithea. This will
 update both repositories.
 .. _waitress: http://pypi.python.org/pypi/waitress
 .. _gunicorn: http://pypi.python.org/pypi/gunicorn
 .. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/

init.d/kallithea-daemon-arch

➞

Show inline comments

modified file chmod 100644 => 100755

init.d/kallithea-daemon-redhat

➞

Show inline comments

modified file chmod 100644 => 100755

kallithea/__init__.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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__
 ~~~~~~~~~~~~~~~~~~
 kallithea
 ~~~~~~~~~
 Kallithea, a web based repository management based on pylons
 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, (C) 2014 Bradley M. Kuhn, and others.
 :license: GPLv3, see LICENSE.md for more details.
 """
 import sys
 import platform
 VERSION = (0, 2, 2)
 BACKENDS = {
     'hg': 'Mercurial repository',
     'git': 'Git repository',
+}
 CELERY_ON = False
 CELERY_EAGER = False
 # link to config for pylons
 CONFIG = {}
 # Linked module for extensions
 EXTENSIONS = {}
 # BRAND controls internal references in database and config to the products
 # own name.
+#
 # NOTE: If you want compatibility with a database that was originally created
 #  for use with the RhodeCode software product, change BRAND to "rhodecode",
 #  either by editing here or by creating a new file:
 #  echo "BRAND = 'rhodecode'" > kallithea/brand.py
 BRAND = "kallithea"
 try:
     from kallithea.brand import BRAND
 except ImportError:
     pass
 # Prefix for the ui and settings table names
 DB_PREFIX = (BRAND + "_") if BRAND != "kallithea" else ""
 # Users.extern_type and .extern_name value for local users
 EXTERN_TYPE_INTERNAL = BRAND if BRAND != 'kallithea' else 'internal'
 # db_migrate_version.repository_id value, same as kallithea/lib/dbmigrate/migrate.cfg
 DB_MIGRATIONS = BRAND + "_db_migrations"
 try:
     from kallithea.lib import get_current_revision
     _rev = get_current_revision(quiet=True)
     if _rev and len(VERSION) > 3:
-        VERSION += ('%s' % _rev[0],)
         VERSION += (_rev[0],)
 except ImportError:
     pass
 __version__ = ('.'.join((str(each) for each in VERSION[:3])))
 __dbversion__ = 31  # defines current db version for migrations
 __platform__ = platform.system()
 __license__ = 'GPLv3'
 __py_version__ = sys.version_info
 __author__ = "Various Authors"
 __url__ = 'https://kallithea-scm.org/'
 is_windows = __platform__ in ['Windows']
 is_unix = not is_windows
 if len(VERSION) > 3:
     __version__ += '.'+VERSION[3]
     if len(VERSION) > 4:
         __version__ += VERSION[4]
     else:
         __version__ += '0'

kallithea/bin/__init__.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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__
 ~~~~~~~~~~~~~~~~~~~~~~
 kallithea.bin
 ~~~~~~~~~~~~~
 Binary scripts for Kallithea
 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.
 """

kallithea/bin/base.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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.base
 ~~~~~~~~~~~~~~~~~~
 Base utils for shell scripts
 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 09, 2013
 :author: marcink
 :copyright: (c) 2013 RhodeCode GmbH, and others.
 :license: GPLv3, see LICENSE.md for more details.
 """
 import os
 import sys
 import random
 import urllib2
 import pprint
 from kallithea.lib.compat import json
 CONFIG_NAME = '.config/kallithea'
 FORMAT_PRETTY = 'pretty'
 FORMAT_JSON = 'json'
 def api_call(apikey, apihost, method=None, **kw):
     """
     Api_call wrapper for Kallithea.
     :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
         :param random_id:
         """
         return {
             "id": random_id,
             "api_key": apikey,
             "method": method,
             "args": kw
+        }
     if not method:
         raise Exception('please specify method name !')
     apihost = apihost.rstrip('/')
     id_ = random.randrange(1, 9999)
     req = urllib2.Request('%s/_admin/api' % apihost,
                       data=json.dumps(_build_data(id_)),
                       headers={'content-type': 'text/plain'})
     ret = urllib2.urlopen(req)
     raw_json = ret.read()
     json_data = json.loads(raw_json)
     id_ret = json_data['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):
     """
     Kallithea config for API
     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 = {}
         if autocreate:
             self.make_config(config)
         if autoload:
             self._conf = self.load_config()
     def __getitem__(self, key):
         return self._conf[key]
     def __nonzero__(self):
         if self._conf:
             return True
         return False
     def __eq__(self):
         return self._conf.__eq__()
     def __repr__(self):
         return 'RcConf<%s>' % self._conf.__repr__()
     def make_config(self, config):
         """
         Saves given config as a JSON dump in the _conf_name location
         :param config:
         """
         update = False
         if os.path.exists(self._conf_name):
             update = True
         with open(self._conf_name, 'wb') as f:
             json.dump(config, f, indent=4)
             f.write('\n')
         if update:
             sys.stdout.write('Updated config in %s\n' % self._conf_name)
         else:
             sys.stdout.write('Created new config in %s\n' % self._conf_name)
     def update_config(self, new_config):
         """
         Reads the JSON config updates it's values with new_config and
         saves it back as JSON dump
         :param new_config:
         """
         config = {}
         try:
             with open(self._conf_name, 'rb') as conf:
                 config = json.load(conf)
-        except IOError, e:
+        except IOError as e:
             sys.stderr.write(str(e) + '\n')
         config.update(new_config)
         self.make_config(config)
     def load_config(self):
         """
         Loads config from file and returns loaded JSON object
         """
         try:
             with open(self._conf_name, 'rb') as conf:
                 return  json.load(conf)
-        except IOError, e:
+        except IOError as e:
             #sys.stderr.write(str(e) + '\n')
             pass

kallithea/bin/kallithea_api.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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
 ~~~~~~~~~~~~~~~~~
 kallithea.bin.kallithea_api
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Api CLI client for Kallithea
 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"
+    )
     parser = argparse.ArgumentParser(description='Kallithea API cli',
                                      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',
+    )
     group.add_argument('--format', dest='format', type=str,
             help='output format default: `%s` can '
                  'be also `%s`' % (FORMAT_PRETTY, FORMAT_JSON),
             default=FORMAT_PRETTY
+    )
     args, other = parser.parse_known_args()
     return parser, args, other
 def main(argv=None):
     """
     Main execution function for cli
     :param argv:
     """
     if argv is None:
         argv = sys.argv
     conf = None
     parser, args, other = argparser(argv)
     api_credentials_given = (args.apikey and args.apihost)
     if args.save_config:
         if not api_credentials_given:
             raise parser.error('--save-config requires --apikey and --apihost')
         conf = RcConf(config_location=args.config,
                       autocreate=True, config={'apikey': args.apikey,
                                                'apihost': args.apihost})
         sys.exit()
     if not conf:
         conf = RcConf(config_location=args.config, autoload=True)
         if not conf:
             if not api_credentials_given:
                 parser.error('Could not find config file and missing '
                              '--apikey or --apihost in params')
     apikey = args.apikey or conf['apikey']
     apihost = args.apihost or conf['apihost']
     method = args.method
     # if we don't have method here it's an error
     if not method:
         parser.error('Please specify method name')
     try:
         margs = dict(map(lambda s: s.split(':', 1), other))
     except ValueError:
         sys.stderr.write('Error parsing arguments \n')
         sys.exit()
     if args.format == FORMAT_PRETTY:
         print 'Calling method %s => %s' % (method, apihost)
     json_resp = api_call(apikey, apihost, method, **margs)
     error_prefix = ''
     if json_resp['error']:
         error_prefix = 'ERROR:'
         json_data = json_resp['error']
     else:
         json_data = json_resp['result']
     if args.format == FORMAT_JSON:
         print json.dumps(json_data)
     elif args.format == FORMAT_PRETTY:
         print 'Server response \n%s%s' % (
             error_prefix, json.dumps(json_data, indent=4, sort_keys=True)
+        )
     return 0
 if __name__ == '__main__':
     sys.exit(main(sys.argv))

kallithea/bin/kallithea_backup.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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.backup_manager
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 kallithea.bin.kallithea_backup
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Repositories backup manager, it allows to backups all
 repositories and send it to backup server using RSA key via ssh.
 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: Feb 28, 2010
 :author: marcink
 :copyright: (c) 2013 RhodeCode GmbH, and others.
 :license: GPLv3, see LICENSE.md for more details.
 """
 import os
 import sys
 import logging
 import tarfile
 import datetime
 import subprocess
 logging.basicConfig(level=logging.DEBUG,
                     format="%(asctime)s %(levelname)-5.5s %(message)s")
 class BackupManager(object):
     def __init__(self, repos_location, rsa_key, backup_server):
         today = datetime.datetime.now().weekday() + 1
         self.backup_file_name = "repos.%s.tar.gz" % today
         self.id_rsa_path = self.get_id_rsa(rsa_key)
         self.repos_path = self.get_repos_path(repos_location)
         self.backup_server = backup_server
         self.backup_file_path = '/tmp'
         logging.info('starting backup for %s', self.repos_path)
         logging.info('backup target %s', self.backup_file_path)
     def get_id_rsa(self, rsa_key):
         if not os.path.isfile(rsa_key):
             logging.error('Could not load id_rsa key file in %s', rsa_key)
             sys.exit()
         return rsa_key
     def get_repos_path(self, path):
         if not os.path.isdir(path):
             logging.error('Wrong location for repositories in %s', path)
             sys.exit()
         return path
     def backup_repos(self):
         bckp_file = os.path.join(self.backup_file_path, self.backup_file_name)
         tar = tarfile.open(bckp_file, "w:gz")
         for dir_name in os.listdir(self.repos_path):
             logging.info('backing up %s', dir_name)
             tar.add(os.path.join(self.repos_path, dir_name), dir_name)
         tar.close()
         logging.info('finished backup of mercurial repositories')
     def transfer_files(self):
         params = {
                   'id_rsa_key': self.id_rsa_path,
                   'backup_file': os.path.join(self.backup_file_path,
                                              self.backup_file_name),
                   'backup_server': self.backup_server
+                  }
         cmd = ['scp', '-l', '40000', '-i', '%(id_rsa_key)s' % params,
                '%(backup_file)s' % params,
                '%(backup_server)s' % params]
         subprocess.call(cmd)
         logging.info('Transfered file %s to %s', self.backup_file_name, cmd[4])
     def rm_file(self):
         logging.info('Removing file %s', self.backup_file_name)
         os.remove(os.path.join(self.backup_file_path, self.backup_file_name))
 if __name__ == "__main__":
     repo_location = '/home/repo_path'
     backup_server = 'root@192.168.1.100:/backups/mercurial'
     rsa_key = '/home/id_rsa'
     B_MANAGER = BackupManager(repo_location, rsa_key, backup_server)
     B_MANAGER.backup_repos()
     B_MANAGER.transfer_files()
     B_MANAGER.rm_file()

kallithea/bin/kallithea_config.py

➞

Show inline comments

-#!/usr/bin/env python
+#!/usr/bin/env python2
 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 configuration generator for Kallithea
 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
 import sys
 import uuid
 import argparse
 from mako.template import Template
 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(
         description='Kallithea CONFIG generator with variable replacement',
         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 '
                                                'builtin template', action='store_true')
     args, other = parser.parse_known_args()
     return parser, args, other
 def _escape_split(text, sep):
     """
     Allows for escaping of the separator: e.g. arg='foo\, bar'
     It should be noted that the way bash et. al. do command line parsing, those
     single quotes are required. a shameless ripoff from fabric project.
     """
     escaped_sep = r'\%s' % sep
     if escaped_sep not in text:
         return text.split(sep)
     before, _, after = text.partition(escaped_sep)
     startlist = before.split(sep)  # a regular split is fine here
     unfinished = startlist[-1]
     startlist = startlist[:-1]
     # recurse because there may be more escaped separators
     endlist = _escape_split(after, sep)
     # finish building the escaped value. we use endlist[0] becaue the first
     # part of the string sent in recursion is the rest of the escaped value.
     unfinished += sep + endlist[0]
     return startlist + [unfinished] + endlist[1:]  # put together all the parts
 def _run(argv):
     parser, args, other = argparser(argv)
     if not len(sys.argv) > 1:
         print parser.print_help()
         sys.exit(0)
     # defaults that can be overwritten by arguments
     tmpl_stored_args = {
         'http_server': 'waitress',
         'lang': 'en',
         'database_engine': 'sqlite',
         'host': '127.0.0.1',
         'port': 5000,
         'error_aggregation_service': None,
+    }
     if other:
         # parse arguments, we assume only first is correct
         kwargs = {}
         for el in _escape_split(other[0], ','):
             kv = _escape_split(el, '=')
             if len(kv) == 2:
                 k, v = kv
                 kwargs[k] = v
         # update our template stored args
         tmpl_stored_args.update(kwargs)
     # use default that cannot be replaced
     tmpl_stored_args.update({
         'uuid': lambda: uuid.uuid4().hex,
         'here': os.path.abspath(os.curdir),
     })
     if args.show_defaults:
         for k,v in tmpl_stored_args.iteritems():
             print '%s=%s' % (k, v)
         sys.exit(0)
     try:
         # built in template
         tmpl_file = os.path.join(here, TMPL)
         if args.template:
             tmpl_file = args.template
         with open(tmpl_file, 'rb') as f:
             tmpl_data = f.read()
+            tmpl_data = f.read().decode('utf-8')
             if args.raw:
                 tmpl = tmpl_data
             else:
                 tmpl = Template(tmpl_data).render(**tmpl_stored_args)
         with open(args.filename, 'wb') as f:
             f.write(tmpl)
+            f.write(tmpl.encode('utf-8'))
         print 'Wrote new config file in %s' % (os.path.abspath(args.filename))
     except Exception:
         from mako import exceptions
         print exceptions.text_error_template().render()
 def main(argv=None):
     """
     Main execution function for cli
     :param argv:
     """
     if argv is None:
         argv = sys.argv
     return _run(argv)
 if __name__ == '__main__':
     sys.exit(main(sys.argv))

kallithea/bin/kallithea_gist.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Gist CLI client for Kallithea
 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
 import stat
 import argparse
 import fileinput
 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"
+    )
     parser = argparse.ArgumentParser(description='Kallithea Gist cli',
                                      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',
                        help='create private Gist')
     group.add_argument('-f', '--filename',
                        help='set uploaded gist filename, '
                             'also defines syntax highlighting')
     group.add_argument('-d', '--description', help='Gist description')
     group.add_argument('-l', '--lifetime', metavar='MINUTES',
                        help='gist lifetime in minutes, -1 (DEFAULT) is forever')
     group.add_argument('--format', dest='format', type=str,
                        help='output format DEFAULT: `%s` can '
                        'be also `%s`' % (FORMAT_PRETTY, FORMAT_JSON),
             default=FORMAT_PRETTY
+    )
     args, other = parser.parse_known_args()
     return parser, args, other
 def _run(argv):
     conf = None
     parser, args, other = argparser(argv)
     api_credentials_given = (args.apikey and args.apihost)
     if args.save_config:
         if not api_credentials_given:
             raise parser.error('--save-config requires --apikey and --apihost')
         conf = RcConf(config_location=args.config,
                       autocreate=True, config={'apikey': args.apikey,
                                                'apihost': args.apihost})
         sys.exit()
     if not conf:
         conf = RcConf(config_location=args.config, autoload=True)
         if not conf:
             if not api_credentials_given:
                 parser.error('Could not find config file and missing '
                              '--apikey or --apihost in params')
     apikey = args.apikey or conf['apikey']
     host = args.apihost or conf['apihost']
     DEFAULT_FILENAME = 'gistfile1.txt'
     if other:
         # skip multifiles for now
         filename = other[0]
         if filename == '-':
             filename = DEFAULT_FILENAME
             gist_content = ''
             for line in fileinput.input('-'):
                 gist_content += line
         else:
             with open(filename, 'rb') as f:
                 gist_content = f.read()
     else:
         filename = DEFAULT_FILENAME
         gist_content = None
         # little bit hacky but cross platform check where the
         # stdin comes from we skip the terminal case it can be handled by '-'
         mode = os.fstat(0).st_mode
         if stat.S_ISFIFO(mode):
             # "stdin is piped"
             gist_content = sys.stdin.read()
         elif stat.S_ISREG(mode):
             # "stdin is redirected"
             gist_content = sys.stdin.read()
         else:
             # "stdin is terminal"
             pass
     # make sure we don't upload binary stuff
     if gist_content and '\0' in gist_content:
         raise Exception('Error: binary files upload is not possible')
     filename = os.path.basename(args.filename or filename)
     if gist_content:
         files = {
             filename: {
                 'content': gist_content,
                 'lexer': None
+            }
+        }
         margs = dict(
             lifetime=args.lifetime,
             description=args.description,
             gist_type='private' if args.private else 'public',
             files=files
+        )
         json_data = api_call(apikey, host, 'create_gist', **margs)['result']
         if args.format == FORMAT_JSON:
             print json.dumps(json_data)
         elif args.format == FORMAT_PRETTY:
             print json_data
             print 'Created %s gist %s' % (json_data['gist']['type'],
                                           json_data['gist']['url'])
     return 0
 def main(argv=None):
     """
     Main execution function for cli
     :param argv:
     """
     if argv is None:
         argv = sys.argv
     try:
         return _run(argv)
-    except Exception, e:
+    except Exception as e:
         print e
         return 1
 if __name__ == '__main__':
     sys.exit(main(sys.argv))

Changeset was too big and was cut off... Show full diff anyway

0 comments (0 inline, 0 general)