Metadata-Version: 1.1
Name: djangocms-icon
Version: 1.1.0
Summary: Adds icon plugin to django CMS.
Home-page: https://github.com/divio/djangocms-icon
Author: Divio AG
Author-email: info@divio.com
License: BSD
Description: ===============
        django CMS Icon
        ===============
        
        
        |pypi| |build| |coverage|
        
        **django CMS Icon** is a plugin for `django CMS <http://django-cms.org>`_
        that allows you to insert an icon (font or svg) into your project.
        
        This addon is compatible with `Divio Cloud <http://divio.com>`_ and is also available on the
        `django CMS Marketplace <https://marketplace.django-cms.org/en/addons/browse/djangocms-icon/>`_
        for easy installation.
        
        .. image:: preview.gif
        
        
        Contributing
        ============
        
        This is a an open-source project. We'll be delighted to receive your
        feedback in the form of issues and pull requests. Before submitting your
        pull request, please review our `contribution guidelines
        <http://docs.django-cms.org/en/latest/contributing/index.html>`_.
        
        One of the easiest contributions you can make is helping to translate this addon on
        `Transifex <https://www.transifex.com/projects/p/djangocms-icon/>`_.
        
        
        Documentation
        =============
        
        See ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-icon/blob/master/setup.py>`_
        file for additional dependencies:
        
        * Python 2.7, 3.4 or higher
        * Django 1.11 or higher
        
        
        Installation
        ------------
        
        For a manual install:
        
        * run ``pip install djangocms-icon``
        * add ``djangocms_icon`` to your ``INSTALLED_APPS``
        * run ``python manage.py migrate djangocms_icon``
        
        
        Configuration
        -------------
        
        The django CMS Icon plugin ships with Font Awesome as default. You can
        configure this through::
        
            DJANGOCMS_ICON_SETS = [
                ('fontawesome', 'fa', 'Font Awesome'),
                (ICONSET, 'icon', 'SVG icons'),
            ]
        
        In this example we keep the Font Awesome default and add our own SVG icon set
        on top of it. ``ICONSET`` is an external reference to a JSON file at the root
        of your project setting up your custom SVG icon set::
        
            with open('iconset.json') as fh:
                ICONSET = fh.read()
        
        Here an example of its content::
        
            {
                "svg": true,
                "spritePath": "sprites/icons.svg",
                "iconClass": "icon",
                "iconClassFix": "icon-",
                "icons": [
                    "icon-icon1",
                    "icon-icon2",
                    "..."
                ]
            }
        
        ``svg`` and ``spritePath`` are only required when using an SVG set. You can
        also use this to generate your own icon font definitions or add them straight
        to the ``DJANGOCMS_ICON_SETS`` setting.
        
        `djangocms-boilerplate-webpack <https://github.com/divio/djangocms-boilerplate-webpack/blob/master/tools/tasks/icons/json.js>`_
        can generate the ``iconset.json`` automatically for you through ``gulp icons``.
        
        In addition **you need to load** the resources for your fonts in
        ``/admin/djangocms_icon/includes/assets.html`` through your project in order for
        the icon picker to pick up your custom icons.
        
        Make sure the icons names contain the iconset prefix as shown in the example,
        the widget will determine the iconset based on that. They can be omitted if only
        one iconset is used.
        
        
        Running Tests
        -------------
        
        You can run tests by executing::
        
            virtualenv env
            source env/bin/activate
            pip install -r tests/requirements.txt
            python setup.py test
        
        
        .. |pypi| image:: https://badge.fury.io/py/djangocms-icon.svg
            :target: http://badge.fury.io/py/djangocms-icon
        .. |build| image:: https://travis-ci.org/divio/djangocms-icon.svg?branch=master
            :target: https://travis-ci.org/divio/djangocms-icon
        .. |coverage| image:: https://codecov.io/gh/divio/djangocms-icon/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/divio/djangocms-icon
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
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.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
