Welcome to Django Sponsors’s documentation!¶

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.

Change log¶

Check the history changes CHANGELOG.

License¶

MIT License. See LICENSE.

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up django-sponsors for local development.

1. Fork the django-sponsors repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/django-sponsors.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv django-sponsors
   $ cd django-sponsors/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ flake8 sponsors tests
$ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/miguelfg/django-sponsors/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_sponsors

Development Lead¶

• Miguel Fiandor <miguel.fiandor.gutierrez@gmail.com>

Contributors¶

None yet. Why not be the first?

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