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 app in your INSTALLED_APPS project’s section.

INSTALLED_APPS = (
  ...
  '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.1.2.tar.gz (118.0 kB view details)

Uploaded Source

Built Distribution

django_emoticons-1.1.2-py2.py3-none-any.whl (142.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-emoticons-1.1.2.tar.gz
Algorithm Hash digest
SHA256 1fd8cbf36eed13410341d230d0a28358dfe3ede6966bd4d01c1edfd0a1bca134
MD5 639daa49d2242a8a2b75a74054974a28
BLAKE2b-256 a9f222c37d962b754e2e69bd08e2e72a64c6394d900ab12ff8b3b500104467f1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_emoticons-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6f3be23f1b8bf0ed0dd0c9b68bbf687f688ae3376952c452f4e231002fbeb6f8
MD5 c1112485684d18663d72039f8b53b056
BLAKE2b-256 4be44b5ba8a205287fd15343155c1f72f7804390bfa8f357185f3e6d9558bdbf

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