Metadata-Version: 1.1
Name: django-icons
Version: 0.1.0
Summary: Icons for Django
Home-page: https://github.com/zostera/django-icons
Author: Dylan Verheul
Author-email: dylan@zostera.nl
License: BSD-3-Clause
Description: django-icons
        ------------
        
        Icons for Django
        
        .. image:: https://travis-ci.org/zostera/django-icons.svg?branch=develop
            :target: https://travis-ci.org/zostera/django-icons
        
        .. image:: https://coveralls.io/repos/github/zostera/django-icons/badge.svg?branch=develop
           :target: https://coveralls.io/github/zostera/django-icons?branch=develop
        
        .. image:: https://img.shields.io/pypi/v/django-icons.svg
            :target: https://pypi.python.org/pypi/django-icons
            :alt: Latest PyPI version
        
        
        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
        
        .. code:: Django
        
           {% 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:
        
        .. code:: bash
        
           tox
        
        Run the tests only for the current environment like this:
        
        .. code:: bash
        
           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.1.0 - in progress
        ===================
        
        - 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
Keywords: django-icons
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
