Favicon Extractor

0.7.0 · maintenance · verified Mon Apr 13

favicon is a Python library designed to find and extract a website's favicon. It simplifies the process of locating favicons, which can be in various locations on a website. The current version is 0.7.0, released in August 2019. The release cadence appears to be infrequent.

Warnings

deprecated The `headers` argument in `favicon.get()` was deprecated in version 0.7.0. Passing a dictionary directly to `headers` will not work as expected.
Fix: Instead of `favicon.get(url, headers={'User-Agent': 'my-agent'})`, pass keyword arguments directly to the function, e.g., `favicon.get(url, user_agent='my-agent')` or `favicon.get(url, **{'headers': {'User-Agent': 'my-agent'}})` if you need to pass a dictionary of headers.
gotcha The `favicon` library has not been updated since August 2019. While it generally works, it might not handle all modern favicon detection methods or edge cases found on newer websites. Consider alternative, more actively maintained libraries for complex scenarios.
Fix: For websites where `favicon.get()` fails to find icons, manually inspect the page's HTML `<head>` for `<link rel="icon" ...>` tags or try a more robust, actively developed favicon extraction library like `extract-favicon` if more advanced features (e.g., async support, size guessing, DuckDuckGo/Google API fallbacks) are needed.
gotcha The `favicon.get()` function returns a list of `Favicon` objects. It is common to assume only one favicon exists or to directly access `icons[0]`. However, a website might provide multiple favicons (e.g., different sizes, formats).
Fix: Always check if the `icons` list is not empty before attempting to access elements like `icons[0]`. Iterate through the list if you need to inspect all available favicons or apply logic to select the 'best' one based on your criteria (e.g., largest size).

Install

pip install favicon Install stable version

Imports

get
```
import favicon
icons = favicon.get(url)
```
The primary function `get` is typically accessed via the main `favicon` module.

Quickstart

This quickstart demonstrates how to import the `favicon` library and use its `get()` function to retrieve a list of `Favicon` objects for a given URL. It then prints the URL and dimensions of the first found favicon.

import favicon

# Example URL
url = "https://www.google.com"

# Get all favicons for the URL
icons = favicon.get(url)

# The 'icons' variable is a list of Favicon objects.
# Each Favicon object has attributes like .url, .width, .height, .format.

if icons:
    # Print the URL of the first (and often best) favicon
    print(f"Found favicon URL: {icons[0].url}")
    # You can also access other properties
    print(f"Size: {icons[0].width}x{icons[0].height}")
else:
    print(f"No favicons found for {url}")

view raw JSON →