Files
@ 8d98924c58b1
Branch filter:
Location: kallithea/docs/usage/vcs_support.rst - annotation
8d98924c58b1
2.2 KiB
text/prs.fallenstein.rst
tests: add as little code as possible in __init__.py
kallithea/tests/__init__.py contained quite a lot of code, including the test
base class TestController. This in itself may be considered bad practice.
Specifically, this poses a problem when using pytest 3.0+, in which asserts
in some files are not automatically rewritten to give improved assert
output. That problem can be fixed by explicitly registering such files for
assertion rewriting, but that register call should be executed _before_ said
files are imported. I.e. if the register call is in
kallithea/tests/__init__.py, assert calls in __init__.py itself can not be
rewritten.
Since the TestController base class does effectively contain asserts, and we
do not want to execute the register call from somewhere outside the
kallithea/tests directory, we need to move the TestController class to
another file (kallithea/tests/base.py) so we can have a register call in
__init__.py before loading base.py.
While not strictly necessary to fix the mentioned pytest problem, we take
the opportunity to fully clean __init__.py and move everything to
the new kallithea/tests/base.py. While doing so, unnecessary imports are
removed, and imports are ordered alphabetically. Explicit imports of symbols
from modules that were already imported as a whole, are removed in favor of
fully qualifying the references (e.g. tempfile._RandomNameSequence).
kallithea/tests/__init__.py contained quite a lot of code, including the test
base class TestController. This in itself may be considered bad practice.
Specifically, this poses a problem when using pytest 3.0+, in which asserts
in some files are not automatically rewritten to give improved assert
output. That problem can be fixed by explicitly registering such files for
assertion rewriting, but that register call should be executed _before_ said
files are imported. I.e. if the register call is in
kallithea/tests/__init__.py, assert calls in __init__.py itself can not be
rewritten.
Since the TestController base class does effectively contain asserts, and we
do not want to execute the register call from somewhere outside the
kallithea/tests directory, we need to move the TestController class to
another file (kallithea/tests/base.py) so we can have a register call in
__init__.py before loading base.py.
While not strictly necessary to fix the mentioned pytest problem, we take
the opportunity to fully clean __init__.py and move everything to
the new kallithea/tests/base.py. While doing so, unnecessary imports are
removed, and imports are ordered alphabetically. Explicit imports of symbols
from modules that were already imported as a whole, are removed in favor of
fully qualifying the references (e.g. tempfile._RandomNameSequence).
601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 fbbe80e3322b 601282d36c06 601282d36c06 601282d36c06 fbbe80e3322b 601282d36c06 ed2fb6e84a02 fbbe80e3322b 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 36a35394b3cb 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 9cef5a168b88 9cef5a168b88 9cef5a168b88 fbbe80e3322b 9cef5a168b88 ed2fb6e84a02 fbbe80e3322b b52a1ccee927 b52a1ccee927 b52a1ccee927 9cef5a168b88 9cef5a168b88 b52a1ccee927 b52a1ccee927 b52a1ccee927 b52a1ccee927 b52a1ccee927 9cef5a168b88 b52a1ccee927 9cef5a168b88 9cef5a168b88 b52a1ccee927 9cef5a168b88 9cef5a168b88 9cef5a168b88 9cef5a168b88 b52a1ccee927 b52a1ccee927 b52a1ccee927 9cef5a168b88 b52a1ccee927 9cef5a168b88 b52a1ccee927 b52a1ccee927 601282d36c06 fbbe80e3322b 601282d36c06 601282d36c06 b52a1ccee927 | .. _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 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/
|