The first Git web viewer that Just Works™.
Project description
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:
- Mailing list:
- On PyPI:
- 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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
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
Algorithm | Hash digest | |
---|---|---|
SHA256 |
423062df9ecc0b95201c43ddf1492370bdbd8a50b550f73c064adaea080288ac
|
|
MD5 |
f09b2efa77baa496fc4a101b1a133f9e
|
|
BLAKE2b-256 |
127bb3f7f88872156d4995eb8794a35457bb9839159c5b953bc2d062d7b44ed2
|