Skip to main content

Icons for Django

Project description


CI Coverage Status Latest PyPI version Any color you like

Icons for Django

  • Define your icons in your settings, with defaults for name, title and other attributes.
  • Generate icons using template tags.
  • Supports Font Awesome, Material, Bootstrap 3 and images.
  • Add other libraries and custom icon sets by subclassing IconRenderer.

More information


Install using pip.

pip install django-icons

Define an icon in your

    "ICONS": {
        "edit": {"name": "far fa-pencil"},

Render an icon in a Django template.

{% load icons %}
{% icon 'edit' %}

This will generate the FontAwesome 5 pencil icon in regular style.

<i class="far fa-pencil"></i>

Add extra classes and attributes to your predefined icon.

{% load icons %}
{% icon 'edit' extra_classes='fa-fw my-own-icon' title='Update' %}

These will be added to the HTML output.

<i class="far fa-pencil fa-fw my-own-icon" title="Update"></i>


This package requires a combination of Python and Django that is currently supported.

See "Supported Versions" on

Local installation

This section assumes you know about local Python versions and virtual environments.

To clone the repository and install the requirements for local development:

$ git clone git://
$ cd django-icons
$ pip install -U pip -r requirements-dev.txt

Running the demo

You can run the example app:

cd example && run python runserver

Running the tests

The test suite requires tox to be installed. Run the complete test suite like this:


Test for the current environment can be run with the Django command.

python test


Our plans at Zostera for an icon tool originate in We isolated this into a Font Awesome tool in When using our own product, we felt that the icon tool provided little improvement over plain HTML. Also, Font Awesome's icon names did not match the the intended function of the icon.

This is how we came to think of a library that:

  • Took a limited number of arguments
  • Converted those arguments into an icon
  • Was able to support multiple icon libraries
  • And could easily be extended by users

This is how we came to write and use django-icons.

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-icons-21.3.tar.gz (31.3 kB view hashes)

Uploaded source

Built Distribution

django_icons-21.3-py3-none-any.whl (12.6 kB view hashes)

Uploaded py3

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