Skip to main content

Essential Gravatar support for Django. Features helper methods, templatetags and a full test suite!

Project description

A lightweight django-gravatar app. Includes helper methods for interacting with gravatars outside of template code.

If you like this library and it’s saved you some time, please consider supporting further development with a Gittip donation!

https://secure.travis-ci.org/twaddington/django-gravatar.png

Features

  • Helper methods for constructing a gravatar url and checking an email for an existing gravatar

  • Templatetags for generating a gravatar url or gravatar <img> tag.

  • Full test suite!

Installing

Install from PyPi:

You can pip install the app directly from GitHub:

$ pip install git+git://github.com/twaddington/django-gravatar.git#egg=DjangoGravatar

Alternatively, you can now install directly from PyPi!

$ pip install django-gravatar2

Make sure you install django-gravatar2 as there are several other incompatible django-gravatar libraries available.

Add django_gravatar to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = (
    # ...
    'django_gravatar',
)

Basic Usage

Use in code:

from django_gravatar.helpers import get_gravatar_url, has_gravatar, get_gravatar_profile_url, calculate_gravatar_hash

url = get_gravatar_url('alice@example.com', size=150)
gravatar_exists = has_gravatar('bob@example.com')
profile_url = get_gravatar_profile_url('alice@example.com')
email_hash = calculate_gravatar_hash('alice@example.com')

Use in templates:

{% load gravatar %}

{% gravatar_url user.email 150 %}
# https://secure.gravatar.com/avatar/hash.jpg?size=150

{% gravatar user.email 150 %}
# <img class="gravatar" src="https://secure.gravatar.com/avatar/hash.jpg?size=150" width="150" height="150" alt="" />

{% gravatar user.email 150 "user@example.com" %}
# <img class="gravatar" src="https://secure.gravatar.com/avatar/hash.jpg?size=150" width="150" height="150" alt="user@example.com" />

{% gravatar_profile_url user.email %}
# https://secure.gravatar.com/hash

Configuring

The following options can be configured in your settings.py:

GRAVATAR_URL # Gravatar base url. Defaults to ‘http://www.gravatar.com/

GRAVATAR_SECURE_URL # Gravatar base secure https url. Defaults to ‘https://secure.gravatar.com/

GRAVATAR_DEFAULT_SIZE # Gravatar size in pixels. Defaults to ‘80’

GRAVATAR_DEFAULT_IMAGE # An image url or one of the following: ‘mm’, ‘identicon’, ‘monsterid’, ‘wavatar’, ‘retro’. Defaults to ‘mm’

GRAVATAR_DEFAULT_RATING # One of the following: ‘g’, ‘pg’, ‘r’, ‘x’. Defaults to ‘g’

GRAVATAR_DEFAULT_SECURE # True to use https by default, False for plain http. Defaults to True

Contributing

Feel free to fork django-gravatar on GitHub! We’d love to see your pull requests. Please make sure you run tests before submitting a patch.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-gravatar2-1.1.4.tar.gz (6.1 kB view details)

Uploaded Source

File details

Details for the file django-gravatar2-1.1.4.tar.gz.

File metadata

File hashes

Hashes for django-gravatar2-1.1.4.tar.gz
Algorithm Hash digest
SHA256 529a75e319783e2407bc34d8b80f7a724babfc92d3673c0a88d3b9d117d3a42a
MD5 487e4fc3da0d7bd3904744ef4fd40773
BLAKE2b-256 21fb2dba48cfe5f61d9c72eddc93013cef445cc160cc55f30391012cf9906c09

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page