colorframe 0.3.0
Python utility to add borders to my photography pictures
Requires Python: >=3.9

<h1 align="center">
  <b>colorframe</b>
</h1>

A simple package to add colored borders on pictures.

## Install

This code is compatible with all currently supported Python versions.
It can be installe in a virtual enrivonment with:

```bash
python -m pip install colorframe
```

## Usage

With this package is installed in the activated enrivonment, it can be called through `python -m colorframe`.
Detailed usage goes as follows:

```bash
 Usage: python -m colorframe [OPTIONS] [PATH]                                              
                                                                                           
 Add colored borders on pictures, easily.                                                  
                                                                                           
╭─ Arguments ─────────────────────────────────────────────────────────────────────────────╮
│   path      [PATH]  Location, relative or absolute, to the file or directory of files   │
│                     to add a colored border to.                                         │
│                     [default: None]                                                     │
╰─────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────────────────╮
│ --left                      INTEGER  Width of the frame to add on the left image edge.  │
│                                      [default: 0]                                       │
│ --right                     INTEGER  Width of the frame to add on the right image edge. │
│                                      [default: 0]                                       │
│ --top                       INTEGER  Height of the frame to add on the top image edge.  │
│                                      [default: 0]                                       │
│ --bottom                    INTEGER  Height of the frame to add on the bottom image     │
│                                      edge.                                              │
│                                      [default: 0]                                       │
│ --color                     TEXT     The desired color of the added border. Should be a │
│                                      keyword recognized by Pillow.                      │
│                                      [default: white]                                   │
│ --log-level                 TEXT     The base console logging level. Can be 'debug',    │
│                                      'info', 'warning' and 'error'.                     │
│                                      [default: info]                                    │
│ --install-completion                 Install completion for the current shell.          │
│ --show-completion                    Show completion for the current shell, to copy it  │
│                                      or customize the installation.                     │
│ --help                               Show this message and exit.                        │
╰─────────────────────────────────────────────────────────────────────────────────────────╯
```

The script will crawl files, add borders and export the results in a newly created `outputs` folder.

You can otherwise import the high-level object from the package, and use at your convenience.
For instance, to add a blue border of 150px on the left and 72px on the bottom of all images in a folder:

```python
from colorframe import BorderCreator

border_api = BorderCreator(
    commandline_pathp="path/to/images/",
    left_border=150,
    bottom_border=72,
    color="blue",
)
border_api.execute_target()
```

---

<div align="center">
  <sub><strong>Made with ♥︎ by fsoubelet</strong></sub>
  <br>
  <sub><strong>MIT &copy 2020 Felix Soubelet</strong></sub>
</div>