django-featured-objects

Simple Django app for making any object featured.

Authored by Pedro Burón, and some great contributors.

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install django-featured-objects-redux

Setup

You'll need to add featured to INSTALLED_APPS in your project's settings.py file:

INSTALLED_APPS += [
    'featured',
]

Then run ./manage.py migrate to create the required database tables.

Configuration

There is only one mandatory configuration option you need to set in your settings.py :

FEATURABLE_MODELS = (
    ('app_label', 'model_name'),
    ('app_label', 'another_model_name'),
)

Please see the example application. This application is used to manually test the functionalities of this package. This also serves as a good example.

You need Django 1.8 or above to run that. It might run on older versions but that is not tested.

Usage

[TBD]

Contributing

If you've found a bug, implemented a feature or customized the template and think it is useful then please consider contributing. Patches, pull requests or just suggestions are welcome!

License

django-featured-objects-redux is released under the GPLv3 license.