A Django application for defining images that should be shown on the frontpage of your website in a slider. Each image can have a title, description and a generic foreign key to any object in your database.

You need to install the following prerequisites in order to use this app:

pip install Django
pip install Pillow
pip install django-filer
pip install simple-translation
pip install South

If you want to install the latest stable release from PyPi:

$ pip install django-hero-slider

If you feel adventurous and want to install the latest commit from GitHub:

$ pip install -e git://github.com/bitmazk/django-hero-slider.git#egg=hero_slider

Add filer, easy_thumbnails and hero_slider to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...,
    'filer',
    'easy_thumbnails'
    'hero_slider',
)

Include the urls for this app:

urlpatterns = patterns(
    '',
    url(r'^hero-slider/', include('hero_slider.urls')),
)

Run the South migrations:

./manage.py migrate

Login to the Django admin and create some SliderItem objects. Each SliderItem should point to some other object (with a generic foreign key).

In your template you can display the slider like this:

{% load hero_slider_tags %}

{% render_hero_slider %}

<script type="text/javascript">
$(document).ready(function() {
    // put all your jQuery goodness in here.
    $('.carousel').carousel({
        /* interval: 3000 */
    })
});
</script>

Alternatively you can use the get_slider_items assignment tag:

{% load hero_slider_tags %}

{% get_slider_items as items %}
{% include "some_template/slider.html with items=items %}

If you want to change the look and feel of the slider, just override the hero_slider/carousel.html template.

If you want to contribute to this project, please perform the following steps:

# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 django-hero-slider
$ pip install -r requirements.txt
$ ./logger/tests/runtests.sh
# You should get no failing tests

$ git co -b feature_branch master
# Implement your feature and tests
# Describe your change in the CHANGELOG.txt
$ git add . && git commit
$ git push origin feature_branch
# Send us a pull request for your feature branch

Whenever you run the tests a coverage output will be generated in tests/coverage/index.html. When adding new features, please make sure that you keep the coverage at 100%.

Check the issue tracker on github for milestones and features to come.