Skip to main content

The first Git web viewer that Just Works™.

Project description

https://travis-ci.org/jonashaag/klaus.svg?branch=master

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

img1 img2 img3

Installation

pip install klaus

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

Usage

See also: Klaus wiki

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

See also deployment section in the wiki.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klaus-0.4.10.zip (35.2 kB view details)

Uploaded Source

File details

Details for the file klaus-0.4.10.zip.

File metadata

  • Download URL: klaus-0.4.10.zip
  • Upload date:
  • Size: 35.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for klaus-0.4.10.zip
Algorithm Hash digest
SHA256 423062df9ecc0b95201c43ddf1492370bdbd8a50b550f73c064adaea080288ac
MD5 f09b2efa77baa496fc4a101b1a133f9e
BLAKE2b-256 127bb3f7f88872156d4995eb8794a35457bb9839159c5b953bc2d062d7b44ed2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page