Metadata-Version: 1.1
Name: django-sponsors
Version: 0.1.2
Summary: Django App to easily manage project sponsors
Home-page: https://github.com/miguelfg/django-sponsors
Author: Miguel Fiandor
Author-email: miguel.fiandor.gutierrez@gmail.com
License: MIT
Description: =============================
        Django Sponsors
        =============================
        
        .. image:: https://badge.fury.io/py/django-sponsors.png
            :target: https://badge.fury.io/py/django-sponsors
        
        .. image:: https://travis-ci.org/miguelfg/django-sponsors.png?branch=master
            :target: https://travis-ci.org/miguelfg/django-sponsors
        
        .. image:: https://coveralls.io/repos/miguelfg/django-sponsors/badge.png?branch=master
            :target: https://coveralls.io/r/miguelfg/django-sponsors?branch=master
        
        Django App to easily manage Django projects sponsors
        
        Documentation
        -------------
        
        The full documentation is at https://django-sponsors.readthedocs.org.
        
        Installation
        ------------
        
        Install Django Sponsors:
        
        1. Using pip::
        
            pip install django-sponsors
        
        2. Add the ``sponsors`` application to ``INSTALLED_APPS`` in your settings file::
        
            INSTALLED_APPS = (
                ...
                'sponsors',
                ...
            )
        3. Sync database::
        
            ``$ ./manage.py syncdb``  and
            ``$ ./manage.py migrate``
        
        **Important:** South 1.0 or greater is required to run migrations.
        
        4. Run the collectstatic management command::
        
            ``$ /manage.py collectstatic``
        
        This will copy static sponsors.css into the directory given by the STATIC_ROOT setting.
        
        5. Load in your template the sponsors.css file like this::
        
            <link rel="stylesheet" href="{% static "sponsors/css/sponors.css" %}">
        
        This will copy static sponsors.css into the directory given by the STATIC_ROOT setting.
        
        
        6. [OPTIONAL] Add sponsors urls into your project's urls.py file::
        
            (r'^sponsors/', include('sponsors.urls')),
        
        This will give url access to sponsors' views, not many in the very firsts versions :-(
        
        
        Usage
        -----
        
        Then use it in a project:
        
        To show all sponsors in uncategorized way::
        
            {% show_sponsors %}
        
        To show only platinum sponsors with its default platinum styles (see sponsors.css)::
        
            {% show_sponsors 'platinum' %}
        
        To show gold and silver sponsors with their default gold and silver styles (see sponsors.css)::
        
            {% show_sponsors 'gold,silver' %}
        
        
        Settings
        --------
        * SPONSOR_EXPIRATES = False
        * SPONSOR_EXPIRE_ON_MONTHS = 12
        * SPONSOR_LOGO_WIDTH = 200
        * SPONSOR_LOGO_HEIGHT = None
        
        
        Features
        --------
        * Template Tags
        * Models
        
        
        Tests
        -----
        To run the tests on 'sponsors' application, simply type the following command::
        
            $ python manage.py test sponsors
        
        
        
        TODOs
        -----
        * add more kind of representations (columns, with descriptions, titles, ...)
        * coverage 100%
        * test logo custom sizes
        * test logo sizes by cats
        * test background colors by cats
        * Become a Sponsor View
        * Become a Sponsor Form
        * Custom logo size and create thumbnail automatically
        
        Contributing
        ------------
        Check the tips at `CONTRIBUTING <https://github.com/miguelfg/django-sponsors/blob/master/CONTRIBUTING.rst>`_.
        
        Change log
        ----------
        Check the history changes `CHANGELOG <https://github.com/miguelfg/django-sponsors/blob/master/HISTORY.rst>`_.
        
        License
        -------
        MIT License. See `LICENSE <https://github.com/miguelfg/django-sponsors/blob/master/LICENSE>`_.
        
        
        
        
        
        
        History
        -------
        
        0.1.2 (2015-07-04)
        ++++++++++++++++++
        * Renaming 'type' field to 'category'
        
        0.1.1 (2015-05-28)
        ++++++++++++++++++
        * First REAL release on PyPI :-)
        
        0.1.0 (2015-05-27)
        ++++++++++++++++++
        * First release on PyPI.
        * Basic Sponsor model
        * First version of templatetag
        * Some tests on model, view and templatetag
        * Optional default logo's width and height in settings
        * Basic styles
        * Admin customized
        * Includes a ListView of Sponsors
        
Keywords: django,sponsors,sponsor,logos,logo
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.6
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
