Metadata-Version: 1.1
Name: django-fontawesome
Version: 0.2
Summary: a django app that provides a couple of fontawesome/django related utilities.
Home-page: https://www.github.com/redouane/django-fontawesome
Author: Redouane Zait
Author-email: redouanezait@gmail.com
License: BSD License
Description: ==================
        django-fontawesome
        ==================
        
        .. image:: https://badge.fury.io/py/django-fontawesome.svg
            :target: http://badge.fury.io/py/django-fontawesome
        
        .. image:: https://pypip.in/download/django-fontawesome/badge.png
            :target: https://pypi.python.org/pypi/django-fontawesome/
            :alt: Downloads
        
        .. image:: https://pypip.in/license/django-fontawesome/badge.png
            :target: https://pypi.python.org/pypi/django-fontawesome/
            :alt: License
        
        PS: still under developement, things may change, once stable it will be on PyPI.
        
        django-fontawesome is a django app that provides a couple of fontawesome/django related utilities, namely:
        
        - an IconField to associate fontawesome icons with model instances
        - templatetags to render fontawesome icons
        
        also included:
        
        - admin support for the IconField
        - fr locale translation
        
        
        Requirements
        ============
        
        - PyYAML
        - Select2 (included)
        - JQuery (uses django's jquery in admin panel)
        
        
        Settings
        ========
        by default, django-fontawesome ships with/uses the lastest fontawesome release.
        you can configure django-fontawesome to use another release/source/cdn by using::
        
            FONTAWESOME_CSS_URL # default uses locally shipped version at 'fontawesome/css/font-awesome.min.css'
            FONTAWESOME_CSS_URL = '//cdn.example.com/fontawesome-min.css' # absolute url
            FONTAWESOME_CSS_URL = 'myapp/css/fontawesome.min.css # relative url
        
        you can also tell it the fontawesome prefix, which as of right now is 'fa', using::
        
            FONTAWESOME_PREFIX # default is 'fa'
        
        
        Installation / Usage
        ====================
        
        1. add 'fontawesome' to your installed apps setting like this::
        
            INSTALLED_APPS = (
                ...
                'fontawesome',
            )
        
        2. import and use the iconfield::
            
            from fontawesome.fields import IconField
        
        
            class Category(models.Model):
                ...
                icon = IconField()
        
        
        here's what the widget looks like in the admin panel:
        
        |admin-widget|
        
        3. you can then render the icon in your template like this::
            
            {% for category in categories.all %}
                {% if category.icon %}
                    {{ category.icon.as_html }}
                {% endif %}
            {% endfor %}
        
        
        4. django-fontawesome ships with two template tags, `fontawesome_stylesheet` and `fontawesome_icon`.
            - the former inserts a stylesheet link with a pre-configured href according to the FONTAWESOME_CSS_URL setting
            - the latter renders icons, and accepts the following optional keywords arguments: large, spin, fixed, li : (true/false), rotate: (90/180/270)
         
            ::
        
               {% load fontawesome %}
            
               <head>
                 {% fontawesome_stylesheet %} 
                 ...
               </head>
             
               {% fontawesome_icon 'user' %}
        
               {% fontawesome_icon 'star' large=True spin=True %}
            
               <ul class="fa-ul">
                  <li> {% fontawesome_icon 'home' rotate=90 li=True %} One</li>
               </ul>
        
        
        5. profit!!!
        
        .. |admin-widget| image:: docs/images/admin-widget.png
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
