Skip to main content

Project Logo

The Lupaxa Miscellaneous Toolbox
Part of The Lupaxa Project


lupaxa-favicon-generator

Generate a modern favicon set from one source image (PNG, JPEG, WebP, or SVG): PNG sizes, favicon.ico, Apple touch icon, PWA icons (including maskable), site.webmanifest, optional HTML link snippet, and favicon.svg when the source is SVG.

Built for documentation and product sites used by The Lupaxa Project.

Features

  • One source image → full favicon / PWA icon set
  • Formats: PNG, JPEG, WebP, and SVG (SVG needs system Cairo)
  • Outputs: 16/32 PNG, multi-size ICO, Apple touch 180×180, 192/512 and maskable 512 icons, webmanifest, optional HTML snippet
  • CLI flags for fit mode, padding, theme/background colours, and name metadata
  • Fully typed, linted, formatted, and tested
  • MkDocs documentation included

Installation

From PyPI

pip install lupaxa-favicon-generator

From source (development mode)

pip install -e ".[dev]"

The console command is favicon-generator.

SVG input also requires the system Cairo library (brew install cairo on macOS or apt install libcairo2 on Debian/Ubuntu).

CLI quick start

favicon-generator --help
favicon-generator --version
favicon-generator logo.png
favicon-generator logo.svg \
  --output-dir site/assets/favicons \
  --prefix /assets/favicons/ \
  --name "My App" \
  --short-name "App" \
  --theme-colour "#0A0A0A" \
  --background-colour "#0A0A0A" \
  --background "#0A0A0A" \
  --padding 0.05

Default output directory: ./favicons.

You can also run the CLI as a module:

python -m lupaxa.favicon_generator --help
python -m lupaxa.favicon_generator logo.png

Requirements

  • Python 3.10+
  • Runtime dependencies: Pillow, cairosvg
  • System Cairo for SVG input

Documentation

Online documentation:

Documentation

Source repository:

GitHub

Serve docs locally

From a clone of the repository:

make mkdocs-serve

Then open the local URL printed by MkDocs in your browser.

Development

Clone the repository and install with Make:

make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test
The Lupaxa Project Footer

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lupaxa_favicon_generator-0.1.2.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lupaxa_favicon_generator-0.1.2-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file lupaxa_favicon_generator-0.1.2.tar.gz.

File metadata

  • Download URL: lupaxa_favicon_generator-0.1.2.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lupaxa_favicon_generator-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1a8f430e9be9b6efcf20f121c7cb0334689bc964d81caaa5aaf98a4d2068b70d
MD5 4991df39829bcfbbebc19462a2a57f72
BLAKE2b-256 d33d998d8a2106fe429fd0034ed6a150f5df20982451ce005d38e1a9d52f1020

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_favicon_generator-0.1.2.tar.gz:

Publisher: generate-release.yml on lupaxa-miscellaneous-toolbox/favicon-generator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lupaxa_favicon_generator-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for lupaxa_favicon_generator-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5b1f884c515896fb49ee67c08c0a06d068bc4a3d81e871d9109458498c5b0572
MD5 a0bd032791f3586975ab0716be87da10
BLAKE2b-256 12b1d24d9cf465d69a047d9955a34df297b06b70bb7f7f62abcc79486ae77db9

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_favicon_generator-0.1.2-py3-none-any.whl:

Publisher: generate-release.yml on lupaxa-miscellaneous-toolbox/favicon-generator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

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