Django Sponsors
Django App to easily manage Django projects sponsors
Documentation
The full documentation is at https://django-sponsors.readthedocs.org.
Installation
Install Django Sponsors:
-
Using pip:
pip install django-sponsors
-
Add the
sponsors
application toINSTALLED_APPS
in your settings file:INSTALLED_APPS = ( ... 'sponsors', ... )
-
Sync database:
``$ ./manage.py syncdb`` and ``$ ./manage.py migrate``
Important: South 1.0 or greater is required to run migrations.
-
Run the collectstatic management command:
``$ /manage.py collectstatic``
This will copy static sponsors.css into the directory given by the STATIC_ROOT setting.
-
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.
-
[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.
Change log
Check the history changes CHANGELOG.
License
MIT License. See LICENSE.