Metadata-Version: 2.1
Name: clearbot
Version: 0.2.0
Summary: Clearbit Logo API client
License: MIT
Author: Alban Siffer
Author-email: alban.siffer@irisa.fr
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: loguru (>=0.6.0,<0.7.0)
Requires-Dist: pillow (>=9.4.0,<10.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Description-Content-Type: text/markdown

# clearbot

Clearbit Logo API client.

`clearbot` fetches the logo of company (png file) based on their domain name.

## Install

The script in available through a python package.

```shell
pip install clearbot
```

## Get started

You can run directly the script on a domain.

```shell
clearbot github.com
```

You can pass several domains as well.

```shell
clearbot github.com gitlab.com
```

A file can also be used as input (one domain by line).

```shell
clearbot -f ./domains.txt
```

By default it will output `/tmp/<DOMAIN>.png`. You can change the destination directory with the `-d` option.

```shell
clearbot -d . github.com
```

By default it outputs 512px png file (i.e. the greatest side has 512px). You can change it with the `-s` option.

```shell
clearbot -s 128 github.com
```

Sometimes we may want to remove the white background (by using transparency: alpha = 0). For this purpose, you can use the `-t` options that thresholds the whites (it must be between 0 and 255 as it is applied on a grayscale version of the image).

```shell
clearbot -t 250 github.com
```

## What's next?

- Add tests
- Colorize image
- Print result to the terminal

