Metadata-Version: 2.3
Name: colorframe
Version: 0.2.2
Summary: Python utility to add borders to my photography pictures
Project-URL: homepage, https://github.com/fsoubelet/ColorFrame
Project-URL: repository, https://github.com/fsoubelet/ColorFrame
Author-email: Felix Soubelet <felix.soubelet@cern.ch>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: joblib>=1.3
Requires-Dist: loguru<1.0
Requires-Dist: pillow>=10.0
Requires-Dist: typer>=0.10
Description-Content-Type: text/markdown

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

A simple package to add a colored frame on pictures.

## Install

This code is compatible with all currently supported Python versions.
Install it in your virtual enrivonment with:

```bash
pip install colorframe
```

## Usage

With this package is installed in the activated enrivonment, it can be called through `python -m colorframe` or through a newly created `colorframe` command.

Detailed usage goes as follows:

```bash
Usage: python -m colorframe [OPTIONS] [PATH]                                                 
                                                                                              
 Add a colored frame 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 ──────────────────────────────────────────────────────────────────────────────────╮
│ --vertical                  INTEGER  Size (width) of the whiteframe to add on the vertical │
│                                      image edges.                                          │
│                                      [default: 150]                                        │
│ --horizontal                INTEGER  Size (height) of the whiteframe to add on the         │
│                                      horizontal image edges.                               │
│                                      [default: 150]                                        │
│ --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:

```python
from colorframe import BorderCreator

border_api = BorderCreator(
    commandline_pathp="path_to_your_images", vertical_border=150, horizontal_border=100, 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>
