Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 2.5 KB

README.md

File metadata and controls

98 lines (63 loc) · 2.5 KB
Raw

Embroidery

Build Status Coverage Status

Motivation

TODO

Requirements

Make sure you have both ImageMagick (for image rendering) and GhostScript (for custom text rendering) installed:

On macOS:

brew install imagemagick
brew install gs

NOTE: This library was tested only using ImageMagick version >7. It's not guaranteed it will work with older versions.

Installation

pip install embroidery

Usage

Basic

embroidery --file icon.png --text BETA

Advanced

Custom color

embroidery --file icon.png --color 33cc60 --text BETA

Gradient color

embroidery --file icon.png --color FF00FF-FFFF00 --text BETA

Custom text color

embroidery --file icon.png --color FF00FF-FFFF00 --text BETA --text-color 333

Custom position

embroidery --file icon.png --color FF00FF-FFFF00 --text BETA --position TL

Full list of options

$ embroidery --help

Usage: embroidery [OPTIONS]

Options:
  -f, --file PATH               Image to apply embroidery.  [required]
  -c, --color TEXT              Background color. Defaults to black.
  -t, --text TEXT               Text on top of embroidery. Defaults to None.
  -k, --text-color TEXT         Defaults to white.
  -p, --position [TL|TR|BL|BR]  Top Left, Top Right (default), Bottom Left,
                                Bottom Right.
  -o, --output TEXT             Path for result image. Defaults to image name
                                + '_embroidered'.
  --help                        Show this message and exit.

Contributing

Coming soon

License

This project is distributed under the MIT License.