Skip to main content

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

Purpose

  • 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)

Install

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:

    INSTALLED_APPS = (
        ...
        'awesome_avatar',
    )

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,
                                instance=request.user.profile)
        if form.is_valid():
            form.save()
            return HttpResponseRedirect('/profile/')
    else:
        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():
            Images(image=form.image).save()
            return HttpResponseRedirect('/any/')
    else:
        form = UploadAndCropImageForm()

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

Global Settings

Django’s settings.py:

AWESOME_AVATAR = {
    'width': 100,
    'height': 100,

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

    'save_quality': 90,
    'save_format': 'png',
    ...
}

Metadata

Release files for django-awesome-avatar 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-awesome-avatar 1.1.3
File Size Uploaded Provenance
django-awesome-avatar-1.1.3.tar.gz 58.6 kB Without provenance Details

Release files / django-awesome-avatar-1.1.3.tar.gz

Download URL django-awesome-avatar-1.1.3.tar.gz
Size 58.6 kB
Tags Source
SHA-256 checksum
How to use checksums
f21efe208db74e78abcaa4bcf47ba95419db5ba7babc936d2561db655488910c
BLAKE2b-256 checksum
How to use checksums
b1a0e79f0e0d1190e8fe24ac22cc948176de80c55d9dda56862ea661e6fafdd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-awesome-avatar 1.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page