Documentation

Installation

You can install Favicon Creator using pip:

pip install favicon-creator

Usage

Command Line Interface

To use Favicon Creator from the command line:

favicon-creator input_image.png output_favicon.ico

Python API

To use Favicon Creator in your Python projects:

from favicon_creator import create_favicon

create_favicon('input_image.png', 'output_favicon.ico', sizes=[16, 32, 48, 64])

API Reference

create_favicon(input_path, output_path, sizes=None)

• input_path (str): Path to the input image file
• output_path (str): Path where the favicon will be saved
• sizes (list of int, optional): List of sizes for the favicon. Default is [16, 32, 48, 64]

Configuration

You can configure Favicon Creator by creating a favicon_config.json file in your project directory:

{
    "default_sizes": [16, 32, 48, 64, 128],
    "output_format": "ico",
    "compression_level": 9
}

Troubleshooting

If you encounter any issues, please check our GitHub Issues page or submit a new issue if your problem isn't already reported.