Skip to main content

A usefull and incredible Django application that allow you to use emoticons in your templates :)

Project description

Build Status - develop branch Coverage of the code

Django-emoticons is a django application providing utilities to add emoticons in your templates. Pretty incredible no?

Install

Once you have installed the package in your PYTHON_PATH, register the emoticons and django.contrib.staticfiles apps in your INSTALLED_APPS project’s section.

INSTALLED_APPS = (
  ...
  'django.contrib.staticfiles',
  'emoticons',
  ...
)

Usage

Filter Usage

For our example we will make a template who display the field content of a model, this field has this value:

Coding is fun and sexy :D

So in our templates we will load the emoticons_tags library and use the emoticons filter:

{% load emoticons_tags %}

{{ object.content|emoticons }}

Which will render:

Coding is fun and sexy smile

Tag Usage

The emoticons app also provides a tag named emoticons for converting raw text.

{% load emoticons_tags %}
{% emoticons %}
Documenting is boring but usefull :p
{% endemoticons %}

Which will render :

Documenting is boring but usefull razz

Index

If you want to retrieve a list of all availables emoticons you can use the emoticons_index tag.

{% load emoticons_tags %}
{% emoticons_index as emoticons_list %}
{% for emoticons in emoticons_list %}
<p>{{ emoticons.0|emoticons }}: {{ emoticons|join:" " }}</p>
{% endfor %}

Settings

You can use differents settings for customizing the application:

  • EMOTICONS_DIRECTORY

    The directory where the emoticons files are located, use 'emoticons' as default.

  • EMOTICONS_LIST

    The list of the emoticons used by the application, something like this:

    (('(devil)', 'devil.gif'),
     ('(angel)', 'angel.gif'),
     ((':)', ':-)', ':=)', '(smile)'), 'smile.gif'),
     ((':(', ':-(', ':=(', '(sad)'), 'sadsmile.gif'),
    )

If the HTML code of the emoticons does not fit to your needs, you can override the 'emoticons/emoticon.html' template to adjust it.

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-emoticons-1.2.tar.gz (119.2 kB view details)

Uploaded Source

Built Distribution

django_emoticons-1.2-py2.py3-none-any.whl (142.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-emoticons-1.2.tar.gz.

File metadata

File hashes

Hashes for django-emoticons-1.2.tar.gz
Algorithm Hash digest
SHA256 dc6cfbe53158bc5ec96fdc4b76d2d342145831e71efda7fa73a53d3f5deee3ab
MD5 7b55d9174da75980bfe7a9f3597f89e1
BLAKE2b-256 c307d5cfcacfee8284fba9c29e1bcc712edf4488a044ff7ef0b37720c784d144

See more details on using hashes here.

File details

Details for the file django_emoticons-1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_emoticons-1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6b09d9d882236960c5778710f85d3921a2cf533d82dffdeb8fef4de1fa8f3338
MD5 dd21395a17d70995f4c76efddf288763
BLAKE2b-256 f2f85f92cdfc0da7014b46dfb3b700a7fb272c9b7621a46559073686103da78e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page