A simple Django app to get avatars based on username and initials if no gravatars is associated to the email address.
Project description
=====
django-initial-avatars
=====
django-initial-avatars is a simple Django app which generates avatars based on username and initials. If django_gravatar is installed, user gravatar is preferred.
Dependencies
------------
Generating avatars requires a `Pillow`_ (or PIL) installation with `freetype`_ support.
``freetype`` can easily be installed on ubuntu with _::
$ sudo aptitude install libfreetype6-dev
or on OS X with `homebrew`_::
$ brew install freetype
After installing ``freetype`` Pillow may need to be rebuilt.
Font licensing
--------------
For generating the avatar the font ``Ubuntu Monospace`` is used.
The font is licensed under the Ubuntu Font Licence, see the
`License <http://font.ubuntu.com/licence/>`_
Quick start
-----------
1. install app requirements::
2. install django-initial-avatars through pip::
pip install django-initial-avatars
3. If you want to use gravatar for users who have one, install django-gravatar2::
pip install django-gravatar2
4. Add "django-initial-avatars" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = (
...
'initial_avatars',
['django_gravatar',]
)
5. Include the django-initial-avatar URLconf in your project urls.py like this::
url(r'^avatar/', include('initial_avatars.urls')),
6. Launch development server::
python manage.py runserver
7. Each user has now an endpoint for his avatar::
localhost:8000/avatar/user[/size]
8. In your templates, use::
{% load initial_avatars %}
{% get_initial_avatar user [size] %}
or
{% get_initial_avatar user.email [size] %}
9. To-do::
Write Tests
add settings ?
django-initial-avatars
=====
django-initial-avatars is a simple Django app which generates avatars based on username and initials. If django_gravatar is installed, user gravatar is preferred.
Dependencies
------------
Generating avatars requires a `Pillow`_ (or PIL) installation with `freetype`_ support.
``freetype`` can easily be installed on ubuntu with _::
$ sudo aptitude install libfreetype6-dev
or on OS X with `homebrew`_::
$ brew install freetype
After installing ``freetype`` Pillow may need to be rebuilt.
Font licensing
--------------
For generating the avatar the font ``Ubuntu Monospace`` is used.
The font is licensed under the Ubuntu Font Licence, see the
`License <http://font.ubuntu.com/licence/>`_
Quick start
-----------
1. install app requirements::
2. install django-initial-avatars through pip::
pip install django-initial-avatars
3. If you want to use gravatar for users who have one, install django-gravatar2::
pip install django-gravatar2
4. Add "django-initial-avatars" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = (
...
'initial_avatars',
['django_gravatar',]
)
5. Include the django-initial-avatar URLconf in your project urls.py like this::
url(r'^avatar/', include('initial_avatars.urls')),
6. Launch development server::
python manage.py runserver
7. Each user has now an endpoint for his avatar::
localhost:8000/avatar/user[/size]
8. In your templates, use::
{% load initial_avatars %}
{% get_initial_avatar user [size] %}
or
{% get_initial_avatar user.email [size] %}
9. To-do::
Write Tests
add settings ?
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-initial-avatars-0.3.0.tar.gz
(114.6 kB
view hashes)
Close
Hashes for django-initial-avatars-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd54cf3390542ab42afef071004625511da9653dd898494d91fa305e658714ea |
|
MD5 | 96b0a07a10ba87b0ef9ed44e1905a821 |
|
BLAKE2b-256 | 49c7a267cb9bdea3854211263f5a17abbdf012b1eed4506b57ceb6a5d992ffde |