Icons for Django
Project description
django-icons
Icons for Django
Warning
While version < 1 (0.x.y), this project will not be fit for production use, and not adhere to semver. From 1.0.0 on, django-icons will be deemed product ready and semantic versioning will be respected.
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 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
Log of changes to django-icons
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.