Skip to main content

A ridiculously simple avatar generator with initials from names.

Project description

django-initials-avatar

Summary A ridiculously simple avatar generator with initials from names.
Original Repository eddiejibson/avatars
Django Packages packages/django-initials-avatar

Upload Python Package Python package CodeQL

"Buy Me A Coffee"

Installing

First add the application to your Python path. The easiest way is to use pip:

pip install django-initials-avatar

Check the Release History tab on the PyPI package page for pre-release versions. These can be downloaded by specifying the version.

You can also install by downloading the source and running:

python setup.py install

Configuring

Make sure you have add the django_initials_avatar application to your INSTALLED_APPS list:

INSTALLED_APPS = (
    ...
    'django_initials_avatar',
)

Then ensure that your project URL conf is updated.

from django.urls import path, include

urlpatterns = [
    ...
    path("initials-avatar/", include('django_initials_avatar.urls'))
]

Default Background Colors

INITIALS_AVATAR_BG_COLORS = [
    "#E284B3", "#FFED8B", "#681313", "#F3C1C6", "#735372", "#009975", "#FFBD39", "#B1E8ED", "#52437B", "#F76262",
    "#216583", "#293462", "#DD9D52", "#936B93", "#6DD38D", "#888888", "#6F8190", "#BCA0F0", "#AAF4DD", "#96C2ED",
    "#3593CE", "#5EE2CD", "#96366E", "#E38080"
]

Default Text Color

INITIALS_AVATAR_TEXT_COLOR = '#fff'

Default Text Length

INITIALS_AVATAR_TEXT_LENGTH = 2

Default Avatar Width

INITIALS_AVATAR_WIDTH = 500

Default Avatar Height

INITIALS_AVATAR_HEIGHT = 500

Default Avatar Font Size

INITIALS_AVATAR_FONT_SIZE = 250

Avatar Rounded By Default

INITIALS_AVATAR_ROUNDED = False

Avatar Capitalize by Default

INITIALS_AVATAR_CAPITALIZE = False

Avatar Lowercase by Default

INITIALS_AVATAR_LOWERCASE = False

Avatar Bold by Default

INITIALS_AVATAR_BOLD = False

Cache timeout

INITIALS_AVATAR_CACHE_TIMEOUT = 60 * 60

Usage Overview

In most cases it will probably be more efficient to use the template tag to get the avatar's reverse url

{% load initials_avatar %}
{% render_initials_avatar "Your Name Here" %}

You can also pass parameters

{% load initials_avatar %}
{% render_initials_avatar "Your Name Here" background="transparent" %}

Available parameters:

  • name
  • background
  • color
  • length
  • width
  • height
  • size
  • rounded
  • capitalize
  • lowercase
  • bold

Desired next step

Make it possible to render the png instead of an svg, perhaps directly converting the svg to png. However so far the libraries need specific dll's and the intention would be to avoid this type of need.

Project details


Download files

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

Source Distribution

django_initials_avatar-0.0.6.tar.gz (11.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page