https://github.com/haideralipunjabi/icons-promo-maker

A python script to generate promo images for your icon projects
https://github.com/haideralipunjabi/icons-promo-maker

atom-icons icons pillow python vscode-icons

Last synced: about 1 month ago
JSON representation

A python script to generate promo images for your icon projects

• Host: GitHub
• URL: https://github.com/haideralipunjabi/icons-promo-maker
• Owner: haideralipunjabi
• License: mit
• Created: 2018-09-18T11:04:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-18T11:07:09.000Z (over 6 years ago)
• Last Synced: 2023-10-20T20:08:52.867Z (about 1 year ago)
• Topics: atom-icons, icons, pillow, python, vscode-icons
• Language: Python
• Size: 412 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# icons-promo-maker

A python script to generate promo images for your icon projects

Sample Image from [atom-icons](https://github.com/hackesta/atom-icons)  

![sample](promo.png)

## Usage  

Put your icons in `icons` folder and run `main.py`

##### Configurations  

The following configurations are available:

| Variable | Values | Description |

|----------|--------|-------------|

| ICONS_FOLDER | filepath | Directory containing icons *Keep `/` at end* |

| ASSETS_FOLDER | filepath | Directory containing assets *Keep `/` at end* |

| SUPPORTED_TYPES | array of filetypes | Supported filetypes for icons |

| GITHUB_URL | URL | Github URL of your Icon Project Repo |

| IMAGE_CONFIG['name'] | string | Filename of generated image |

| IMAGE_CONFIG['mode'] | [MODE](https://pillow.readthedocs.io/en/3.0.x/handbook/concepts.html#concept-modes) | Image Mode to be used |

| IMAGE_CONFIG['title'] | string | Title of Image |

| IMAGE_CONFIG['github_mark'] | dark/light | Github Mark to use *Opposite to shade of background* |

| IMAGE_CONFIG['dimensions'] | int tuple | Dimension of generated image |

| IMAGE_CONFIG['background'] | HEX | Background Color to use |

| IMAGE_CONFIG['text_color'] | HEX | Text Color to use |

| IMAGE_CONFIG['text_font'] | filename | Font File to use *Should be present in `ASSETS_FOLDER`* |

| IMAGE_CONFIG['text_size'] | int | Font Size to use *best: 5% of image height* |

| IMAGE_CONFIG['spacing'] | int | Spacing between various elements |