Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding the AVATAR_GRAVATAR_FIELD setting #82

Merged
merged 3 commits into from
Dec 21, 2015
Merged

Adding the AVATAR_GRAVATAR_FIELD setting #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ac3e46
Adding the AVATAR_GRAVATAR_FIELD setting to define the user field use…
Mar 17, 2014
10c9e8a
Fix GRAVATAR_FIELD > AVATAR_GRAVATAR_FIELD
Mar 17, 2014
d182c83
Fixing getattr
Mar 17, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions avatar/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class AvatarConf(AppConf):
RESIZE_METHOD = Image.ANTIALIAS
STORAGE_DIR = 'avatars'
GRAVATAR_BASE_URL = 'https://www.gravatar.com/avatar/'
GRAVATAR_FIELD = 'email'
GRAVATAR_BACKUP = True
GRAVATAR_DEFAULT = None
DEFAULT_URL = 'avatar/img/default.jpg'
Expand Down
4 changes: 2 additions & 2 deletions avatar/templatetags/avatar_tags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ def avatar_url(user, size=settings.AVATAR_DEFAULT_SIZE):
params = {'s': str(size)}
if settings.AVATAR_GRAVATAR_DEFAULT:
params['d'] = settings.AVATAR_GRAVATAR_DEFAULT
path = "%s/?%s" % (hashlib.md5(force_bytes(user.email)).hexdigest(),
urlencode(params))
path = "%s/?%s" % (hashlib.md5(force_bytes(getattr(user,
settings.AVATAR_GRAVATAR_FIELD))).hexdigest(), urlencode(params))
return urljoin(settings.AVATAR_GRAVATAR_BASE_URL, path)

return get_default_avatar_url()
Expand Down
29 changes: 17 additions & 12 deletions docs/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,40 +32,40 @@ that are required. A minimal integration can work like this:

1. List this application in the ``INSTALLED_APPS`` portion of your settings
file. Your settings file will look something like::

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

2. Update your database::

python manage.py syncdb

3. Add the avatar urls to the end of your root urlconf. Your urlconf
will look something like::

urlpatterns = patterns('',
# ...
(r'^avatar/', include('avatar.urls')),
)

4. Somewhere in your template navigation scheme, link to the change avatar
page::

<a href="{% url 'avatar_change' %}">Change your avatar</a>

5. Wherever you want to display an avatar for a user, first load the avatar
template tags::

{% load avatar_tags %}

Then, use the ``avatar`` tag to display an avatar of a default size::

{% avatar user %}

Or specify a size (in pixels) explicitly::

{% avatar user 65 %}

Template tags and filter
Expand Down Expand Up @@ -118,15 +118,20 @@ AVATAR_GRAVATAR_BACKUP
True.

AVATAR_GRAVATAR_DEFAULT
A string determining the style of the default Gravatar. Available options
listed in the
(Gravatar documentation)[https://en.gravatar.com/site/implement/images/#default-image].
A string determining the style of the default Gravatar. Available options
listed in the
(Gravatar documentation)[https://en.gravatar.com/site/implement/images/#default-image].
Ex. 'retro'. Defaults to None.

AVATAR_DEFAULT_URL
The default URL to default to if ``AVATAR_GRAVATAR_BACKUP`` is set to False
and there is no ``Avatar`` instance found in the system for the given user.

AVATAR_GRAVATAR_FIELD
The name of the user's field containing the gravatar email. Defaults to
``email``. If you put, for example, ``gravatar``, django-avatar will get the
user's gravatar in ``user.gravatar``.

AVATAR_MAX_SIZE
File size limit for avatar upload. Default is ``1024 * 1024`` (1mb).

Expand Down