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.2.tar.gz
(114.6 kB
view hashes)
Close
Hashes for django-initial-avatars-0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffb804cab519538a5ffdc3d1e2c353905376ff3b9479441d7c73c36159c8b156 |
|
MD5 | 22ff3ebe6a2c4edb66b5ca34c85027a7 |
|
BLAKE2b-256 | 27cf43f2c71009d6b2e0eeee3b6052708d2b09662f5d5e24597d7ba6e3b63c18 |