Metadata-Version: 2.1
Name: django-featured-objects-redux
Version: 0.1.2
Summary: Simple Django app for making any object featured.
Home-page: https://github.com/bashu/django-featured-objects-redux
Author: Pedro Buron
Author-email: pedro@witoi.com
Maintainer: Basil Shubin
Maintainer-email: basil.shubin@gmail.com
License: GPLv3 License
Download-URL: https://github.com/bashu/django-featured-objects-redux/zipball/master
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires: Django (>=1.4.2)
Requires-Dist: swapper

django-featured-objects
=======================

Simple Django app for making any object featured.

Authored by `Pedro Burón <http://pedroburon.info/>`_, and some great
`contributors <https://github.com/bashu/django-featured-objects-redux/contributors>`_.

.. image:: https://img.shields.io/pypi/v/django-featured-objects-redux.svg
    :target: https://pypi.python.org/pypi/django-featured-objects-redux/

.. image:: https://img.shields.io/pypi/dm/django-featured-objects-redux.svg
    :target: https://pypi.python.org/pypi/django-featured-objects-redux/

.. image:: https://img.shields.io/github/license/bashu/django-featured-objects-redux.svg
    :target: https://pypi.python.org/pypi/django-featured-objects-redux/

.. image:: https://img.shields.io/travis/bashu/django-featured-objects-redux.svg
    :target: https://travis-ci.org/bashu/django-featured-objects-redux/


Installation
============

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

.. code-block:: shell

    pip install django-featured-objects-redux

Setup
=====

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

.. code-block:: python

    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`` :

.. code-block:: python

    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.

.. _django: https://www.djangoproject.com


