Metadata-Version: 2.5
Name: lupaxa-favicon-generator
Version: 0.1.1
Summary: Generate a modern favicon set from a single source image.
Project-URL: Homepage, https://github.com/lupaxa-miscellaneous-toolbox/favicon-generator
Project-URL: Repository, https://github.com/lupaxa-miscellaneous-toolbox/favicon-generator
Project-URL: Issues, https://github.com/lupaxa-miscellaneous-toolbox/favicon-generator/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) 2026 The Lupaxa Project
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENCE
Keywords: cli,favicon,icons,pillow,pwa
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: cairosvg
Requires-Dist: pillow<13.0,>=12.0
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <a href="https://github.com/lupaxa-miscellaneous-toolbox">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/miscellaneous-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
  </a>
</p>
<h3 align="center">
  The Lupaxa Miscellaneous Toolbox<br />
  Part of The Lupaxa Project
</h3>

<br />

# 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

```bash
pip install lupaxa-favicon-generator
```

### From source (development mode)

```bash
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

```bash
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:

```bash
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](https://favicon-generator.thelupaxaproject.org/)

Source repository:

[GitHub](https://github.com/lupaxa-miscellaneous-toolbox/favicon-generator)

### Serve docs locally

From a clone of the repository:

```bash
make mkdocs-serve
```

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

## Development

Clone the repository and install with Make:

```bash
make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test
```

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
