Sphene Community Tools (SCT) - http://sct.sphene.net
Copyright (C) by Herbert Poul (herbert.poul@gmail.com)


Sphene Community Tools are django applications designed to be easily
pluggable into any django project.


## Directories

- sphenecoll/	Collection of django application (the base source for SCT).
- static/	Static media files which contain images and css.

## Requirements

- [Django](http://www.djangoproject.com) - I'm using the latest version from 
  the subversion trunk.
    - For use with Django 0.96 you need to add the following configuration to 
      your settings.py: SPH_SETTINGS = { 'django096compatibility': True, }
- Python >= 2.4
- [PyCrypto](http://sf.net/projects/pycrypto) - (e.g. debian package python-crypto)

## Installation

### Django bug workarounds

The current django trunk contains a bug in the select_related method.

To workaround the problem (ie. don't use it) you need to activate the 
following setting:

    SPH_SETTING['workaround_select_related_bug'] = True

See <http://code.djangoproject.com/ticket/4789> - If this patch was already
committed or you applied it manually you can disable the workaround to
improve performance.

### Apply Patches

As of 2007-05-13 no patches are needed any more. The customization of
the permalink function is now included in sphene.community.sphutils.

- permalink_with_additional_function_arg.diff - see <http://code.djangoproject.com/ticket/3530>


### Python library path

You need to add libs/ and sphenecoll/ to your python include path and
static/ needs to be served from your django installation.
(static/sphene/ is enough)

### Maintenance cron job (Optional)

To recaulcate heat for forum threads and similar, you should add the following
cronjob to run once a day (or similar)

    echo -e "from sphene.community.signals import trigger_maintenance\ntrigger_maintenance()" | ./manage.py shell --plain

### Cache

SCT makes use of django caching framework - it is therefore advised to 
configure CACHE_BACKEND django setting & co.
look at the [django caching documentation](http://www.djangoproject.com/documentation/cache/)

## Examples

The examples/ directory (currently) contains one example project.
Please see the README file in it's directory (examples/simpleproject)
for more information.