Metadata-Version: 2.4
Name: binx-og-image-generator
Version: 1.3.6
Summary: generates og image for xebia.com and binx.io blog
Author-email: Mark van Holsteijn <mark@binx.io>
License: restricted
Project-URL: Homepage, https://github.com/binxio/og-image-generator
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: pillow
Requires-Dist: requests
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-runner; extra == "test"
Provides-Extra: dev
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Dynamic: license-file

# Binx image generator

The binx-og-image-generator is a tool to generate images for your blog.

```
Usage: binx-og-image-generator [OPTIONS] IMAGE

  generate an og image for blog

Options:
  --title TEXT                    of the blog  [required]
  --subtitle TEXT                 of the blog  [required]
  --author TEXT                   of the blog  [required]
  --email TEXT                    of the blog author
  -g, --gradient-magnitude FLOAT  of the mask
  --output TEXT                   filename of the image, default prefix og- to
                                  filename
  --overwrite / --no-overwrite    output file
  --brand [xebia.com|binx.io]     of the blog  [required]
  --theme TEXT                    of the Xebia branding
  --help                          Show this message and exit.
```

To generate an images, type:

```console
docker run --rm \
    -v $PWD:$PWD \
    -w $PWD \
    ghcr.io/binxio/og-image-generator \
    --title "foo" \
    --subtitle "bar" \
    --author "binx consultant" \
    ./banner.jpg
```

The generated image can be found in your current directory and is named `og-banner.jpg`.

## Pipenv

If you which to install the binx-og-image-generator on your host machine follow these steps.

### Prerequisites

- Pipenv

### Steps to use the OG Image Generator

- pip install pipenv
- pipenv shell
- pipenv install
- binx-og-image-generator --title "foo" --subtitle "bar" --author "binx consultant" banner.jpg
