klaus

klaus: a simple, easy-to-set-up Git web viewer that Just Works™.

(If it doesn’t Just Work for you, please file a bug.)

Demo:: http://klausdemo.lophus.org
Mailing list:: http://groups.google.com/group/klaus-users
On PyPI:: http://pypi.python.org/pypi/klaus/
Wiki:: https://github.com/jonashaag/klaus/wiki
License:: ISC (BSD)

Contributing

Please do it!

I’m equally happy with bug reports/feature ideas and code contributions. If you have any questions/issues, I’m happy to help!

For starters, here are a few ideas what to work on. :-)

Features

Super easy to set up – no configuration required
Syntax highlighting
Git Smart HTTP support

Installation

pip install klaus

(Optional dependencies: see Markup rendering in the wiki.)

Usage

Using the klaus script

NOTE: This is intended for testing/low-traffic local installations only! The klaus script uses wsgiref internally which doesn’t scale at all (in fact it’s single-threaded and non-asynchronous).

To run klaus using the default options:

klaus [repo1 [repo2 ...]]

For more options, see:

klaus --help

Using a real server

The klaus module contains a make_app function which returns a WSGI app.

An example WSGI helper script is provided with klaus (see klaus/contrib/wsgi.py), configuration being read from environment variables. Use it like this (uWSGI example):

uwsgi -w klaus.contrib.wsgi \
      --env KLAUS_SITE_NAME="Klaus Demo" \
      --env KLAUS_REPOS="/path/to/repo1 /path/to/repo2 ..." \
      ...

Gunicorn example:

gunicorn --env KLAUS_SITE_NAME="Klaus Demo" \
         --env KLAUS_REPOS="/path/to/repo1 /path/to/repo2 ..." \
         klaus.contrib.wsgi

Release files for klaus 0.4.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for klaus 0.4.10
File	Size	Uploaded
klaus-0.4.10.zip	35.2 kB	Jun 28, 2015	Details

Release files / klaus-0.4.10.zip

Download URL	klaus-0.4.10.zip
Size	35.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`423062df9ecc0b95201c43ddf1492370bdbd8a50b550f73c064adaea080288ac`
BLAKE2b-256 checksum How to use checksums	`127bb3f7f88872156d4995eb8794a35457bb9839159c5b953bc2d062d7b44ed2`
Upload date	Jun 28, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No