django-icons 0.2.1

Icons for Django

django-icons

Icons for Django

Features

Use simple template tags to generate icons in your web application. Supports Font Awesome out of the box, easily adaptable for other icon libraries.

The basic usage is

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

Requirements

Django >= 1.11 and a matching Python version. Using Python 3 is strongly recommended.

Running the demo

You can run the small demo app that is part of the test suite. This requires Django, so you may have to pip install django in your environment. To run the demo, from the root of the project (where you can find manage.py, run:

python manage.py runserver

Running the tests

The test suite uses tox. Run the complete test suite like this:

tox

Run the tests only for the current environment like this:

python manage.py test

Origin

Our plans at Zostera for an icon tool originate in https://github.com/dyve/django-bootstrap3. We isolated this into a Font Awesome tool in https://github.com/zostera/django-fa. 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.

Changelog

0.2.1 - 2018-07-01

• Bug fixes and improvements to ImageRenderer (@mbourqui)

0.2.0 - 2018-06-30

• Add icons from images, contribution by @mbourqui
• Adopt black code style (https://github.com/ambv/black)

0.1.0 - 2018-01-11

• Set default branch to master
• Make icon function available as import from django_icons (fixes)
• Add MaterialRenderer for Material icons (http://google.github.io/material-design-icons/)

0.0.5 - 2017-12-21

• Fix typo’s
• Adjust tox matrix to currently supported Django versions
• Fixed names of tests
• Add tests for BaseRenderer

0.0.4 - 2017-06-22

• Autogenerate docs for icon template tag
• Fix typo in README

0.0.3 - 2017-06-22

• Bug fixes
• More tests
• More documentation

0.0.2 - 2017-06-19

• Updated docs and tests
• Demo of custom SVG renderer included
• FontAwesome and Bootstrap3 renderers included
• New structure for settings dict
• First documentation, linked to ReadTheDocs
• First tests
• Introducing the icon template tag

0.0.1 - 2017-06-15

• First publication on GitHub and PyPI
• Non-functional, just names and tests