favico

Python library to generate the perfect favicons for every device.

$ pip install favico

import favico

Installation

favico uses ImageMagick to generate the favicons.

For ubuntu, you can simply install libmagicwand-dev like this:

$ apt-get install libmagickwand-dev

Usage

Using favico is super easy! You can either create favicons from an image or from a color:

$ favico color "#f542ec" ./my-favicon-dir
$ favico image ./path/to/favicon/image.png ./my-favicon-dir

Once you ran the command to test it out, you will see more info on how to add the favicons to your page (ready to copy paste!)

By default, it is assumed that your website is deployed on the root /. To template the favicons with another base path, just set the --base (-b) option:

$ favico --base /prod/deployment/subdir color "#f542ec" ./my-favicon-dir
$ favico --base https://my-webside.com color "#f542ec" ./my-favicon-dir

Development

For detailed instructions see CONTRIBUTING.

Tests

You can run tests with

$ invoke test
$ invoke test --min-coverage=90     # Fail when code coverage is below 90%
$ invoke type-check                 # Run mypy type checks

Linting and formatting

Lint and format the code with

$ invoke format
$ invoke lint

All of this happens when you run invoke pre-commit.

Note

This project is still in the alpha stage and should not be considered production ready.