A django-xicon documentation

django-xicon is a Django reusable application to handle a modern bunch of site icons

Nowadays <link rel="shortcut icon" href="favicon.ico" type="image/x-icon" sizes="16x16"/> is not enough for good site or web application. Apple, Microsoft and Google creates their own standards. django-xicon solve the boring problem of reading and implementing of these standards requirements through fast and simple Django project configuration. These standards requirements are not fully implemented, but enough to pass most of the checks.

Installation

Obtain your copy of source code from the git repository: $ git clone https://github.com/vint21h/django-xicon.git. Or download the latest release from https://github.com/vint21h/django-xicon/tags/.
Run $ python ./setup.py install from the repository source tree or unpacked archive. Or use pip: $ pip install django-xicon.

Configuration

Add "xicon" to settings.INSTALLED_APPS:

# settings.py

INSTALLED_APPS += [
    "xicon",
]

Add "xicon" to your URLs definitions if you want to serve manifest.json or browserconfig.xml:

# urls.py

from django.urls import include, re_path


urlpatterns += [
    re_path(r"^xicon/", include("xicon.urls")),
]

Settings

XICON_FAVICONS: Contains list of favicons. Defaults to []. Each element must be according to the next structure:

{
    "src": "favicon.ico",
    "type": "image/x-icon",
    "size": "16x16",
}  # type: Dict[str, Optional[str]]

Where src key is a path to the favicon file in Django static directory, type is favicon file mime-type and size key contains icon’s width and height and can be omitted.

XICON_APPLE_TOUCH_ICONS: Contains list of apple touch icons. Defaults to []. Each element must be according to the next structure:

{
    "src": "apple-touch-icon-144x144.png",
    "size": "144x144",
}  # type: Dict[str, Optional[str]]

Where src key is a path to the icon file in Django static directory and size contains icon’s width and height and can be omitted.

XICON_APPLE_TOUCH_ICON_MASK_ICON_SRC: Contains path to Safari pinned tabs icon. Defaults to "".
XICON_APPLE_TOUCH_ICON_MASK_ICON_COLOR: Contains path to Safari pinned tab icon hover color. Defaults to "", must start with #.
XICON_APPLE_MOBILE_WEB_APP_STATUS_BAR_STYLE_COLOR: Contains iOS web application status bar color. Defaults to "".
XICON_APPLE_MOBILE_WEB_APP_TITLE: Contains iOS web application launch icon title. Defaults to "".
XICON_ANDROID_CHROME_THEME_COLOR: Contains android chrome web application toolbar color also used in manifest.json. Defaults to "", must start with #.
XICON_ANDROID_CHROME_ICONS: Contains a list of icons for manifest.json. Defaults to []. Each element must be according to the next structure:

{
    "src": "android-chrome-64x64.png",
    "type": "image/png",
    "sizes": "64x64",
}  # type: Dict[str, str]

Where src key is a path to the icon file in Django static directory, type is favicon file mime-type and size key contains icon’s width and height.

XICON_ANDROID_CHROME_NAME: Contains android chrome web application name for manifest.json. Defaults to "".
XICON_ANDROID_CHROME_SHORT_NAME: Contains android chrome web application short name for manifest.json. Defaults to "".
XICON_ANDROID_CHROME_BACKGROUND_COLOR: Contains android chrome web application background color for manifest.json. Defaults to "", must start with #.
XICON_ANDROID_CHROME_DISPLAY: Contains android chrome web application browser UI mode for manifest.json. Defaults to "".
XICON_ANDROID_CHROME_ORIENTATION: Contains android chrome web application screen orientation for manifest.json. Defaults to "".
XICON_MSAPPLICATION_NAME: Contains microsoft application name. Defaults to "".
XICON_MSAPPLICATION_TILE_COLOR: Contains Microsoft application tile color also used in browserconfig.xml. Defaults to "", must start with #.
XICON_MSAPPLICATION_TILES: Contains list of icons for Microsoft application meta tags and also used in browserconfig.xml. Defaults to []. Each element must be according to the next structure:

{
    "src": "mstile-70x70.png",
    "name": "square70x70logo",
}  # type: Dict[str, str]

Where src key is a path to the icon file in Django static directory and name contains tile name (type).

Usage

If you want to use all power of django-xicon, just set up all settings and include "xicon/includes/xicon.html" to your base template <head> HTML tag:

{# base.html #}

<head>
    {% include "xicon/includes/xicon.html" %}
</head>

Or just for favicons, setup XICON_FAVICONS setting, load "xicon_tags" to your base template and place "xicon_favicons" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_favicons %}
</head>

If you want to setup web application for apple devices, setup all settings prefixed with XICON_APPLE_ and include "xicon/includes/apple.html" to your base template <head> HTML tag:

{# base.html #}

<head>
    {% include "xicon/includes/apple.html" %}
</head>

Or just for apple touch icons, setup APPLE_TOUCH_ICONS setting, load "xicon_tags" to your base template and place "xicon_apple_touch_icons" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_apple_touch_icons %}
</head>

To use Safari pinned tabs mask icon setup XICON_APPLE_TOUCH_ICON_MASK_ICON_SRC and XICON_APPLE_TOUCH_ICON_MASK_ICON_COLOR settings, load "xicon_tags" to your base template and place "xicon_apple_touch_icon_mask_icon" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_apple_touch_icon_mask_icon %}
</head>

To configure iOS web application bar style color setup XICON_APPLE_MOBILE_WEB_APP_STATUS_BAR_STYLE_COLOR setting, load "xicon_tags" to your base template and place "xicon_apple_mobile_web_app_status_bar_style" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_apple_mobile_web_app_status_bar_style %}
</head>

To configure iOS web application launch icon title setup XICON_APPLE_MOBILE_WEB_APP_TITLE setting, load "xicon_tags" to your base template and place "xicon_apple_mobile_web_app_title" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_apple_mobile_web_app_title %}
</head>

If you want to use android chrome related things, just setup all settings prefixed with XICON_ANDROID_CHROME_ and include "xicon/includes/android-chrome.html" to your base template <head> HTML tag:

{# base.html #}

<head>
    {% include "xicon/includes/android-chrome.html" %}
</head>

Or if you need only configure android chrome web application toolbar color, setup XICON_ANDROID_CHROME_THEME_COLOR, load "xicon_tags" to your base template and place "xicon_android_chrome_theme_color" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_android_chrome_theme_color %}
</head>

If you need generate and serve manifest.json, add "xicon" to your URLs definitions, setup next settings: XICON_ANDROID_CHROME_THEME_COLOR, XICON_ANDROID_CHROME_ICONS, XICON_ANDROID_CHROME_NAME, XICON_ANDROID_CHROME_SHORT_NAME, XICON_ANDROID_CHROME_BACKGROUND_COLOR, XICON_ANDROID_CHROME_DISPLAY and XICON_ANDROID_CHROME_ORIENTATION`, and then include "xicon/includes/android-chrome-manifest-meta.html" to your base template <head> HTML tag:

# urls.py

from django.urls import include, re_path


urlpatterns += [
    re_path(r"^xicon/", include("xicon.urls")),
]

{# base.html #}

<head>
    {% include "xicon/includes/android-chrome-manifest-meta.html" %}
</head>

If you want to setup microsoft application configure all settings prefixed with XICON_MSAPPLICATION_ and include "xicon/includes/msapplication.html" to your base template <head> HTML tag:

{# base.html #}

<head>
    {% include "xicon/includes/msapplication.html" %}
</head>

Or if you need only configure microsoft application name, setup XICON_MSAPPLICATION_NAME, load "xicon_tags" to your base template and place "xicon_msapplication_name" in <head> HTML tag of your base template:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_msapplication_name %}
</head>

If you need configure microsoft application tile color, setup XICON_MSAPPLICATION_TILE_COLOR, load "xicon_tags" to your base template and place "xicon_msapplication_tile_color" in <head> HTML tag of your base template:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_msapplication_tile_color %}
</head>

If you need generate and serve browserconfig.xml, add "xicon" to your URLs definitions, setup next settings: XICON_MSAPPLICATION_TILE_COLOR and XICON_MSAPPLICATION_TILES, and then include "xicon/includes/msapplication-browserconfig-meta.html" to your base template <head> HTML tag:

# urls.py

from django.urls import include, re_path


urlpatterns += [
    re_path(r"^xicon/", include("xicon.urls")),
]

{# base.html #}

<head>
    {% include "xicon/includes/msapplication-browserconfig-meta.html" %}
</head>

Or just for microsoft application tiles, setup MSAPPLICATION_TILES setting, load "xicon_tags" to your base template and place "xicon_mstiles" in <head> HTML tag:

{# base.html #}

{% load xicon_tags %}

<head>
    {% xicon_mstiles %}
</head>

Contributing

Fork it
Install GNU Make
Install and configure pyenv and pyenv-virtualenv plugin
Install and configure direnv
Create environment config from example

cp .env.example .env

Install development dependencies:

make install

Create your fix/feature branch:

git checkout -b my-new-fix-or-feature

Check code style and moreover:

make check

Run tests:

make test

Push to the branch:

git push origin my-new-fix-or-feature

Create a new Pull Request

Licensing

django-xicon is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For complete license text see COPYING file.

Contacts

Project Website: https://github.com/vint21h/django-xicon/

Author: Alexei Andrushievich <vint21h@vint21h.pp.ua>

For complete authors list see AUTHORS file.

Metadata

Release files for django-xicon 0.22.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-xicon 0.22.8
File	Size	Uploaded	Provenance
django-xicon-0.22.8.zip	45.8 kB	Feb 19, 2022	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-xicon 0.22.8
File	Interpreter	ABI	Platform	Reset
django_xicon-0.22.8-py3-none-any.whl 31.7 kB Feb 19, 2022 Without provenance	Python 3	none	any	Details

Total release size: 77.4 kB

Release files / django-xicon-0.22.8.zip

Download URL	django-xicon-0.22.8.zip
Size	45.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`d6ce4d96ea4b42ad21e8bba67dab3dd535decb93a6362b3db563b53db1d9b8bc`
BLAKE2b-256 checksum How to use checksums	`c899dd83ab06dbaea34d21404d266401b8829d7a237b4b2f3320acdf327ac8bb`
Upload date	Feb 19, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2`

Release files / django_xicon-0.22.8-py3-none-any.whl

Download URL	django_xicon-0.22.8-py3-none-any.whl
Size	31.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1ca88cbb7b694fb2fd586113cb8b99cf26425a00c5baa1f955d7524e3a320439`
BLAKE2b-256 checksum How to use checksums	`99719a357a8d4ab7759539068639157d3038268a5b14219e03a1bf503341d15a`
Upload date	Feb 19, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2`

Security for django-xicon 0.22.8

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.