Skip to main content
Build Status PyPI version License Test Coverage

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.

Metadata

Release files for favico 0.1.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 favico 0.1.8
File Size Uploaded
favico-0.1.8.tar.gz 7.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for favico 0.1.8
File Interpreter ABI Platform
favico-0.1.8-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 13.4 kB

Release files / favico-0.1.8.tar.gz

Download URL favico-0.1.8.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4e73b05ce403be677391eb8bcc5b046ab432ec536c3491859329452496a8f5f6
BLAKE2b-256 checksum
How to use checksums
4d7fe09636fff9b0e3fd2daecce0a8824f24ca7bb2d84c93fcd064eb98d66964
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

Release files / favico-0.1.8-py2.py3-none-any.whl

Download URL favico-0.1.8-py2.py3-none-any.whl
Size 6.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
dc5df05659843202c6f4d3dd7871148d5e06c9c1aca3f2d1c48c295267241057
BLAKE2b-256 checksum
How to use checksums
0733f2348a714c8f0a2db6d02da4b855f087155a39a7b2715c3e18894c7c1f7b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

Release history Release notifications | RSS feed

This release

0.1.8 This release

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page