# emblematic

Generate emblems from an icon and a background

## Table of contents

- Prerequisites
  - pipx
  - Inkscape
- Command-line interface
  - Installation
  - Usage
    - Show help message
    - Show version number
    - Basic mode
      - Keep input directory structure on generation
      - Specifying the size of the output images
      - Keeping intermediate SVGs
      - Skipping PNG generation
    - Solid mode
    - Shadow mode
    - Duotone mode
- Python interface
  - Installation
  - Usage
  - API reference
    - Emblem composition
      - `compose_basic()`
      - `compose_solid()`
      - `compose_shadow()`
      - `compose_duotone()`
    - SVG modification
      - `stretch_center()`
      - `contain_center()`
      - `combine()`
      - `remove_defs()`
      - `create_defs()`
      - `create_dropshadow()`
      - `fill_all()`
      - `fill_specific()`
    - Command-line interface definition
      - Arguments and options
        - `option_background_file()`
        - `arguments_foreground_filename()`
        - `option_output_dir()`
        - `option_save_svg()`
        - `option_save_png()`
        - `option_width_px()`
        - `option_height_px()`
        - `option_foreground_color()`
        - `option_primary_color()`
        - `option_secondary_color()`
        - `option_shadow_offset_x_px()`
        - `option_shadow_offset_y_px()`
        - `option_shadow_stddev()`
        - `option_shadow_color()`
      - Commands
      - File detection
        - `WorkUnit`
          - `WorkUnit.find()`
          - `WorkUnit.create_destination_parents()`
          - `WorkUnit.destination_svg()`
          - `WorkUnit.write_svg()`
          - `WorkUnit.destination_png()`
          - `WorkUnit.write_png()`

## Useful links

- Index

- Module Index

- Search Page

- emblematic on PyPI

- emblematic on Steffo’s Forge

- PyPI stats for emblematic

## Documentation todos

Todo

Add sample image.

(The original entry is located in /workspace/steffo/emblematic/docs/cli.rst, line 91.)

Todo

Add sample image.

(The original entry is located in /workspace/steffo/emblematic/docs/cli.rst, line 222.)

Todo

Add sample image.

(The original entry is located in /workspace/steffo/emblematic/docs/cli.rst, line 253.)

Todo

Add sample image.

(The original entry is located in /workspace/steffo/emblematic/docs/cli.rst, line 283.)

Todo

Describe how the package can be used in other Python scripts.

(The original entry is located in /workspace/steffo/emblematic/docs/python.rst, line 34.)