{ "info": { "author": "Divio AG", "author_email": "info@divio.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Framework :: Django :: 2.1", "Framework :: Django :: 2.2", "Framework :: Django CMS", "Framework :: Django CMS :: 3.4", "Framework :: Django CMS :: 3.5", "Framework :: Django CMS :: 3.6", "Framework :: Django CMS :: 3.7", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development", "Topic :: Software Development :: Libraries" ], "description": "===============\ndjango CMS Icon\n===============\n\n|pypi| |build| |coverage|\n\n**django CMS Icon** is a plugin for `django CMS `_\nthat allows you to insert an icon (font or svg) into your project.\n\nThis addon is compatible with `Divio Cloud `_ and is also available on the\n`django CMS Marketplace `_\nfor easy installation.\n\n.. image:: preview.gif\n\n\nContributing\n============\n\nThis is a an open-source project. We'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n`_.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors `_\nsection.\n\nOne of the easiest contributions you can make is helping to translate this addon on\n`Transifex `_.\n\n\nDocumentation\n=============\n\nSee ``REQUIREMENTS`` in the `setup.py `_\nfile for additional dependencies:\n\n|python| |django| |djangocms|\n\n\nInstallation\n------------\n\nFor a manual install:\n\n* run ``pip install djangocms-icon``\n* add ``djangocms_icon`` to your ``INSTALLED_APPS``\n* run ``python manage.py migrate djangocms_icon``\n\n\n**A note about django CMS Text CKEditor**\n\nThere are additional steps required for the icon plugin to display correctly\ninside CKEditor.\n\n1. You need to make sure your icon CSS is passed via CKEditors ``contentsCss``\n`parameter `_.\nOn Divio Cloud this can be done through the Addons configuration.\n\n2. CKEditor automatically removes empty tags, you can prevent this by adding\na `javascript configuration file `_\nto ``style_set``.\n\n\nConfiguration\n-------------\n\nThis addon provides a ``default`` template for all instances. You can provide\nadditional template choices by adding a ``DJANGOCMS_ICON_TEMPLATES``\nsetting::\n\n DJANGOCMS_ICON_TEMPLATES = [\n ('svg', 'SVG template'),\n ]\n\nWeb Font Icons\n##############\n\nThe django CMS Icon plugin ships with **Font Awesome 4 as default**. This can\nbe changed by overriding the following setting::\n\n DJANGOCMS_ICON_SETS = [\n ('fontawesome4', 'fa', 'Font Awesome 4'),\n ]\n\nTo use Font Awesome 5 in the above example; see the options below form the\n``DJANGOCMS_ICON_SETS`` listed.\n\nIn addition **you need to load** the resources for your fonts in\n``/admin/djangocms_icon/includes/assets.html``. Add this file to your project\nin order for the icon picker to pick up your custom icons in the admin.\n\nThe icon picker supports `numerous font libraries `_\nout of the box. You can also add multiple font sets like this::\n\n DJANGOCMS_ICON_SETS = [\n ('elusiveicon', 'el', 'Elusive Icons'),\n ('flagicon', 'flag-icon', 'Flag Icons'),\n ('fontawesome4', 'fa', 'Font Awesome 4'),\n ('fontawesome5regular', 'far', 'Font Awesome 5 Regular'),\n ('fontawesome5solid', 'fas', 'Font Awesome 5 Solid'),\n ('fontawesome5brands', 'fab', 'Font Awesome 5 Brands'),\n ('fontawesome5light', 'fal', 'Font Awesome 5 Light', '5.3.1_pro'),\n ('glyphicon', 'glyphicon', 'Glyphicons'),\n ('ionicon', 'ion', 'Ionicons Icons'),\n ('mapicon', 'map-icon', 'Map Icons'),\n ('materialdesign', 'zmdi', 'Material Design'),\n ('octicon', 'octicon', 'Octicons'),\n ('typicon', 'typcn', 'Typicons'),\n ('weathericon', 'wi', 'Weather Icons'),\n ]\n\nYou can also add the version number as a fourth parameter.\nIf no parameter is given the latest version of the bootstrap-iconpicker icon set is used.::\n\n DJANGOCMS_ICON_SETS = [\n ('fontawesome4', 'fa', 'Font Awesome 4', '4.0.0'),\n ('fontawesome5light', 'fal', 'Font Awesome 5 Light', '5.3.1_pro'),\n ]\n\nJust don't forget to include both libraries in the ``assets.html`` file.\nThis is only necessary for the plugin rendering while selecting the icon.\nYou still need to implement the font libraries into your frontend stack.\n\nCustom Web Font Icons\n#####################\n\nYou can also add your own custom web fonts, for this you need to tell the\nicon picker where to find the necessary files::\n\n DJANGOCMS_ICON_SETS = [\n (ICONSET, 'icon', 'Custom web font'),\n ]\n\nIn this example, we add our own font icon set on top of it. Please mind\nthat the second parameter needs to be the icon prefix. ``ICONSET`` is an\nexternal reference to a JSON file at the root of your project setting up\nyour custom font icons, add this before::\n\n with open('iconset.json') as fh:\n ICONSET = fh.read()\n\nHere an example of its content::\n\n {\n \"iconClass\": \"icon\",\n \"icons\": [\n \"icon-icon1\",\n \"icon-icon2\",\n \"...\"\n ]\n }\n\nThe ``iconClass`` refers to the second parameter in the settings file for the\nicon prefix. Make sure both of them are the same. Instead of using an external\nfile you can also write the settings directly to the ``DJANGOCMS_ICON_SETS``\nsetting.\n\n`djangocms-boilerplate-webpack `_\ncan generate the ``iconset.json`` automatically for you through ``gulp icons``.\n\nMake sure the icons names contain the iconset prefix as shown in the example,\nthe widget will determine the iconset based on that. They can be omitted if only\none iconset is used.\n\nDon't forget to also add your custom fonts to\n``/admin/djangocms_icon/includes/assets.html`` into your project.\n\nSVG Icons\n#########\n\ndjango CMS Icon also supports SVG icons. Follow the instructions from\n`Custom Web Font Icons`_ and then adapt the JSON file a bit::\n\n {\n \"svg\": true,\n \"spritePath\": \"sprites/icons.svg\",\n \"iconClass\": \"icon\",\n \"icons\": [\n \"icon-icon1\",\n \"icon-icon2\",\n \"...\"\n ]\n }\n\n``svg`` and ``spritePath`` are the only required additional properties. You\nalso need to add an icon template to your project to render it correctly,\nfor example::\n\n \n \n \n \n \n\n\nRunning Tests\n-------------\n\nYou can run tests by executing::\n\n virtualenv env\n source env/bin/activate\n pip install -r tests/requirements.txt\n python setup.py test\n\n\n.. |pypi| image:: https://badge.fury.io/py/djangocms-icon.svg\n :target: http://badge.fury.io/py/djangocms-icon\n.. |build| image:: https://travis-ci.org/divio/djangocms-icon.svg?branch=master\n :target: https://travis-ci.org/divio/djangocms-icon\n.. |coverage| image:: https://codecov.io/gh/divio/djangocms-icon/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/divio/djangocms-icon\n\n.. |python| image:: https://img.shields.io/badge/python-2.7%20%7C%203.4+-blue.svg\n :target: https://pypi.org/project/djangocms-icon/\n.. |django| image:: https://img.shields.io/badge/django-1.11%20%7C%202.1%20%7C%202.2-blue.svg\n :target: https://www.djangoproject.com/\n.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.4%2B-blue.svg\n :target: https://www.django-cms.org/\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/divio/djangocms-icon", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "djangocms-icon", "package_url": "https://pypi.org/project/djangocms-icon/", "platform": "", "project_url": "https://pypi.org/project/djangocms-icon/", "project_urls": { "Homepage": "https://github.com/divio/djangocms-icon" }, "release_url": "https://pypi.org/project/djangocms-icon/1.4.1/", "requires_dist": null, "requires_python": "", "summary": "Adds icon plugin to django CMS.", "version": "1.4.1" }, "last_serial": 5613273, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "f750860316c8746f77dfe45f0f405a56", "sha256": "74187bb0d9236461f1c8ab1ff0027b3a57b88b43c135fd9b02fbb0df668e7f97" }, "downloads": -1, "filename": "djangocms-icon-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f750860316c8746f77dfe45f0f405a56", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 68160, "upload_time": "2017-12-22T10:06:30", "url": "https://files.pythonhosted.org/packages/87/bd/2faa1284b6d7072d04e2b756cc7bff2f4d55bd7724aff8999632648a51dc/djangocms-icon-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "2afedc2e26a85f8bea2b358ee0ea51fe", "sha256": "fb827673aad4ece1ec22ef99db4b452405383657c485ec61e5f0305b856c3ea7" }, "downloads": -1, "filename": "djangocms-icon-0.2.0.tar.gz", "has_sig": false, "md5_digest": "2afedc2e26a85f8bea2b358ee0ea51fe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 65174, "upload_time": "2017-12-27T16:45:30", "url": "https://files.pythonhosted.org/packages/d3/c2/4f0e570c0cbd83fe4f4ba06f3f1afb1bf248c53d2282c2d62fbf64549fd3/djangocms-icon-0.2.0.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "f4af8dc7f5f7436ebdc9e34428f249e8", "sha256": "c27aac78c18ad96a0c27c8db38742ebbb67641e7d8ee4d9f363ecd718ae6e4ab" }, "downloads": -1, "filename": "djangocms-icon-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f4af8dc7f5f7436ebdc9e34428f249e8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 66940, "upload_time": "2018-02-13T18:03:20", "url": "https://files.pythonhosted.org/packages/bc/22/a4c87f797e71dc1b246250ecdc78cd33ce26979f4ef7c471df32f5fe7dd7/djangocms-icon-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "2814022bbc1d5a5178a326b71b9f5940", "sha256": "c43395c6ea34a7c36dde82fc63d9eaf31820fd103b3ed13470db654cac0bb462" }, "downloads": -1, "filename": "djangocms_icon-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2814022bbc1d5a5178a326b71b9f5940", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 77984, "upload_time": "2018-11-20T09:45:07", "url": "https://files.pythonhosted.org/packages/6a/c1/83fa207f2e3842e33c9b385b4f3c71bd8bbfc4f0a700203f1d0111633c3b/djangocms_icon-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "84b1d6d16c6732ad855723f29f3ea941", "sha256": "ff06cd42d022df332022b87858b9e34a56dbc1a88b6a2fbd3afc5380fbaef235" }, "downloads": -1, "filename": "djangocms-icon-1.1.0.tar.gz", "has_sig": false, "md5_digest": "84b1d6d16c6732ad855723f29f3ea941", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 66969, "upload_time": "2018-11-20T09:45:09", "url": "https://files.pythonhosted.org/packages/dc/aa/1db209ddd9381f6826d8e4ccfefb1e69bcf40bac67772a0cd7a69a269c85/djangocms-icon-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "4bb51bf12e609f4e7abf92eeb141d523", "sha256": "3f3f6244b5124c20b2f58324af07efb2f44dbdec52463ca8b61bc772e4aa94c2" }, "downloads": -1, "filename": "djangocms-icon-1.2.0.tar.gz", "has_sig": false, "md5_digest": "4bb51bf12e609f4e7abf92eeb141d523", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 167051, "upload_time": "2018-12-12T09:38:43", "url": "https://files.pythonhosted.org/packages/9c/08/3b673dbe6582e1bb4d33c3ea803869dc5dca930c09e07f3f56072522da48/djangocms-icon-1.2.0.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "4bffe4a12776fa8ed2b5099f3fcfb26f", "sha256": "f137e9cb6d7205fdb4d1950f7dae66f631ef6e0b8da1dd4445df37b28df49b4b" }, "downloads": -1, "filename": "djangocms-icon-1.3.0.tar.gz", "has_sig": false, "md5_digest": "4bffe4a12776fa8ed2b5099f3fcfb26f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 138475, "upload_time": "2019-03-13T15:51:09", "url": "https://files.pythonhosted.org/packages/ad/43/fb3a2f09b0c7d7816c4fe96717960e2e22dd7a47cfa7aac45d306fdc4d75/djangocms-icon-1.3.0.tar.gz" } ], "1.4.0": [ { "comment_text": "", "digests": { "md5": "17671ea7d5f99b7c5554ce71614d3010", "sha256": "93b559b1de0b188a5490ad2530b6af4c22b7650c7328b21c6d13d85cb9c30cbe" }, "downloads": -1, "filename": "djangocms-icon-1.4.0.tar.gz", "has_sig": false, "md5_digest": "17671ea7d5f99b7c5554ce71614d3010", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 542235, "upload_time": "2019-05-22T12:14:56", "url": "https://files.pythonhosted.org/packages/4c/b4/9ac9e57d6e9481a42889d88c8751b0e014cf5b0428c6fef069e7e5526078/djangocms-icon-1.4.0.tar.gz" } ], "1.4.1": [ { "comment_text": "", "digests": { "md5": "95224d49298d50e6cd1b9011d4a464da", "sha256": "8e33211b3bbfe0ffb9c035b1991b47f94332c1b1b49f84085739aebf99ff69d2" }, "downloads": -1, "filename": "djangocms-icon-1.4.1.tar.gz", "has_sig": false, "md5_digest": "95224d49298d50e6cd1b9011d4a464da", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 146374, "upload_time": "2019-07-31T12:42:11", "url": "https://files.pythonhosted.org/packages/6c/67/b3931b9c97880e132f3131cec410878f325a6ab42d864851970c92b06314/djangocms-icon-1.4.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "95224d49298d50e6cd1b9011d4a464da", "sha256": "8e33211b3bbfe0ffb9c035b1991b47f94332c1b1b49f84085739aebf99ff69d2" }, "downloads": -1, "filename": "djangocms-icon-1.4.1.tar.gz", "has_sig": false, "md5_digest": "95224d49298d50e6cd1b9011d4a464da", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 146374, "upload_time": "2019-07-31T12:42:11", "url": "https://files.pythonhosted.org/packages/6c/67/b3931b9c97880e132f3131cec410878f325a6ab42d864851970c92b06314/djangocms-icon-1.4.1.tar.gz" } ] }