Skip to main content

Django Avatar field

Project description

Django-awesome-avatar is a reusable application providing Avatar model field. It allows crop selected area before saving image.


  • field in profile model instead creating model for saving images
  • HTML5 File API instead hidden iframe AJAX for image preview
  • easy customizable presence (any view and widget templates)


To integrate django-awesome-avatar with your site, there are few things that are required:

  1. Installing:

    pip install django-awesome-avatar
  2. List this application in the INSTALLED_APPS portion of your settings file. Your settings file will look something like:


Usage examples

with ModelForm

Add the AvatarField to your user or profile model:

from awesome_avatar.fields import AvatarField

class Profile(Model):
    user = OneToOneField(User, related_name='profile')
    avatar = AvatarField(upload_to='avatars', width=100, height=100)

Use model form usually way:

class AvatarChangeForm(ModelForm):
    class Meta:
        model = Profile
        fields = ['avatar']

def change_avatar(request):
    if request.method == 'POST':
        form = AvatarChangeForm(request.POST, request.FILES,
        if form.is_valid():
            return HttpResponseRedirect('/profile/')
        form = AvatarChangeForm(instance=request.user.profile)

    return render(request, 'template.html', {'form': form})

with Form

Define some model for saving images:

class Images(Model):
    image = ImageField(upload_to='images')

Use form field for cropping image:

from awesome_avatar import forms as avatar_forms

class UploadAndCropImageForm(Form):
    image = avatar_forms.AvatarField()

def upload_and_crop_image(request):
    if request.method == 'POST':
        form = UploadAndCropImageForm(request.POST)

        if form.is_valid():
            return HttpResponseRedirect('/any/')
        form = UploadAndCropImageForm()

    return render(request, 'template.html', {'form': form})

Global Settings


    'width': 100,
    'height': 100,

    'select_area_width': 400,
    'select_area_height': 300,

    'save_quality': 90,
    'save_format': 'png',

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django-awesome-avatar-1.1.3.tar.gz (58.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page