Welcome to wltrweb’s documentation!

Everything you need to know about wltrweb.

See also: Table of contents | Index | Search Page | FAQ | License | Changelog

Overview

Motivation

I use wltrweb as my repository of common Django apps and functions for web developing. It helps me to set up a new project quickly. And since I want to improve my english and programming skill, I want to share this library.

Issue reports, recommendations and patches are very welcome, anyway.

Important

This library is under development yet and contains undocumented apps and functions. Please only use modules, which are documented here and declared as stable. Other could change any moment.

The documentation

My english badly needs to get improved (as you see). If you find any grammar or spelling mistake, then please let me know it. I would appreciate it very much!

You find the most up to date version under: http://wltrweb.googlecode.com/svn/trunk/docs/html/index.html

Futhermore, every release should contain these docs.

Getting started

Requirements

  • Python 2.5 or greater (not 3.x)
  • Django 1.2 or greater

Installation

  1. Download the latest release from http://code.google.com/p/wltrweb/downloads/list.
  2. Unpack archive.
  3. Run setup.py install. Maybe you have to get root privileges (e.g. with sudo python setup.py install).

Note

You also could put the wltrweb package into your Python path any other way you want. The package is the directory containing directories like apps and utils.

Usage

See documentation of required app or function.

Important

And again: Better do not use modules, which are not documented.

The apps

The wltrweb.apps package contains apps for the Django framework.

wltrweb.apps.mediamanager
This app can manage mediafiles for css/js compression and better caching.

The utils

The wltrweb.utils package contains some helpful functions for the website development with Django. The modules are grouped by topics.

No stable modules here, yet.

The contributions

The wltrweb.contrib package contains helpful functions and classes. Unlike the wltrweb.utils package the functions are bigger and one module contains only one function or class.

No stable modules here, yet.

The hacks

The wltrweb.hacks package contains a couple of hacks for the Django framework. Use it with caution.

No stable modules here, yet.