semvec/pypi-packages huggingface dataset:
imagetitle 0.0.1
 Overlay image, top, bottom, left or right, with a title.
License: MIT
Requires Python: >=3.8,<4.0
Keywords: Image,CLI,Title,Annotate

# Overlay Image Title

This is a tool, ```imagetitle```, to help overlay a small bit of text over an image.

This is especially useful to add some credits to images used in presentations for example.

![Image with overlayed title at the bottom](readme-sample-output.png)

```
imagetitle -i input.png --title="This is title text." -p "bottom"
```

Photo credits for the photo above goto **İrfan Simsar [https://unsplash.com/@irfansimsar]**

## Usage

```console
$ imagetitle [OPTIONS]
```

**Options**:

* `-i, --input PATH`: Image file name.  [default: input.png]
* `-o, --output PATH`: Output file name.  [default: output.png]
* `-p, --position [bottom|top|left|right]`: Where to position the tile.  [default: bottom]
* `-t, --title TEXT`: Text for title.
* `-f, --font TEXT`: Font name or path.
* `-r, --fraction FLOAT RANGE`: What fraction, 0 to 1, of the image edge should be covered by the title?  [default: 0.75]
* `--version`
* `--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.



## Installation

There are a number of ways you could install this utility.

### Python

If you are familiar with the installation of python packages in a virtual environment then you can install with:

```
pip install imagetitle
```

This will give you a command line application that you can use at the terminal.

#### Pipx

Another approach is to use a utility called [Pipx](https://pypi.org/project/pipx/) to install the application.

```console
pipx install imagetitle
or
pipx install git+https://github.com/rnwolf/overlay_image_title/
```

### Docker

The utility is also packaged up in a Docker [image](https://hub.docker.com/r/rnwolf/overlayimagetitle).

If you have docker installed then you can pull down the application and python all in one image.

```
docker pull rnwolf/overlayimagetitle
```

To show application help
```docker run -t -i --rm -v ${PWD}:/app overlayimagetitle:latest```

Show version
```docker run -t -i --rm -v ${PWD}:/app overlayimagetitle:latest --version```

Given a file called input.png in current working dir then with this produce output.png in
```docker run -t -i --rm -v ${PWD}:/app overlayimagetitle:latest -i /app/input.png -f /fnt/Ubuntu-C.ttf```

Open a bash shell inside of the docker container
```docker run -t -i --rm --entrypoint /bin/bash -v ${PWD}:/app overlayimagetitle:latest```

### Setup alias for Docker Image

When using docker to run command setup a command alias for imagetitle
In your powershell profile add the following

```
function imagetitle {
  docker run -it --rm v ${pwd}:/app overlayimagetitle:latest $args
 }
 ```

Or if you use bash terminal then update .bashrc profilr by adding:

```alias imagetitle='docker run -it --rm -v \`pwd\`:/app overlayimagetitle:latest'```