Metadata-Version: 2.1
Name: image-frame
Version: 0.0.3
Summary: Frame your images.
Home-page: https://github.com/Elsombrerobot/image_frame
Author: Marc Ferrer
Author-email: iammarcferrer@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Elsombrerobot/image_frame/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Requires-Python: >=3
Description-Content-Type: text/markdown

Image Frame
===========

Frame your images.
------------------
This program provides simple cli for framing jpeg and png images.

## Requirements
- Python 3.7 or superior.
- Pillow 9.0.0.

Tested only on windows 10.

## Commands
- `--help` , `-h`
  - Show help.
- `--input` , `-i`
  - The input to process. If is dir, will process  all the jpeg of png it finds.
- `--output` , `-o`
  - Exemple : ***./{filename}*** , ***output_file*** , ***.././some/dir/{filename}*** (relative to input). Will create trees and override files. If not specified, output in the input file dir as ***{filename}_framed***. Only **{filename}** is available as key.
- `--size` , `-size`
  - Specify the size of the final image, if not specified, original size is kept and the program just add the frame, so it will be bigger.
- `--frame-size` , `-fs`
  - Specify the size of the frame, as precentage of the greater size of the image, default is 5.
- `--frame-shape` , `-fsh`
  - Specify the shape of the frame. **Values : same, square**.
- `--frame-color` , `-fc`
  - Specify the color of the frame. **Values : median or color** *(see -ac, --available_colors for all colors).* Default is white.
- `--tag-exifs` , `-te`
  - Tag the frame with exif tag at the given location if one location arg is specified. **Values : top, bottom**
- `-d` , `--description`
  - Tag the frame with given string at the given location if one location arg is specified. ocations : top, bottom. Take 2 args, exemple :
  - `--description 'Cool description' bottom` .
- `--font-size-weight` , `-ftw`
  -  Specify the multiplier for the font size. 1 is default.
- `--font-color` , `-fco`
  -  Specify the color of the font. *(see -ac, --available_colors for all colors).*
- `--available-colors` , `-ac`
  - Print all the available color options for `--frame_color` and `--font-color`, skip any other arg.
- `@`
  - A txt file containing a list of args. The args must be one by line :
    - --size
    - 2048
    - --frame-color
    - purple
    - ...
  - Exemple : `@my_args.txt`

## Exemples

Here i have this image **my_image.jpeg** :

<img src=".\docs\images\original_image.jpg" style="width:400px;"/>

If i just process it without giving any args, i have this :

`py -m image_frame -i my_image.jpeg`

<img src=".\docs\images\image_framed.jpg" style="width:400px;"/>

If i want to add a **square frame**, the **exifs at the top**, my instagram **tag at the bottom** , and have an image of **size** 2048 * 2048 : 

`py -m image_frame -i my_image.jpeg --frame-shape square --tag-exifs top --description '@iammarcferrer' bottom --size 2048` 

<img src=".\docs\images\custom_framed_image.jpg" style="width:400px;"/>

If you like colors it is also possible :
`py -m image_frame -i my_image.jpeg --frame-color gold --description 'blue' bottom --font-color green` 

<img src=".\docs\images\color_framed_image.jpg" style="width:400px;"/>

You can visit [@iammarcferrer](https://www.instagram.com/iammarcferrer/) on instagram, where i use it all the time.

