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.0.1.tar.gz (116.8 kB view details)

Uploaded Source

Built Distribution

django_emoticons-1.0.1-py2.py3-none-any.whl (141.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-emoticons-1.0.1.tar.gz
Algorithm Hash digest
SHA256 eb81bbbc0752c3eb8ab7593adb6b481c2e945999eb8205bf915973de4865fb05
MD5 5bdd203249bc78bd93e79d6a66ad4d86
BLAKE2b-256 cd704eafa837043142b201ae9ccb3a0c2de78c9b1b4cda6828428717308cabb8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_emoticons-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7f2f6a8028dce7646f643c380d3a133b191372b5785954c2c27e1955afd3fcd7
MD5 5ed33fadfb02da0299f7dbf4466665c8
BLAKE2b-256 02b3c60495e200ef6d534cf7d95b336accdae19529971fae35a4c48283c06c0e

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