clearbot

Name	clearbot JSON
Version	0.2.0 JSON
	download
home_page
Summary	Clearbit Logo API client
upload_time	2023-02-03 09:30:44
maintainer
docs_url	None
author	Alban Siffer
requires_python	>=3.10,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "clearbot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Alban Siffer",
    "author_email": "alban.siffer@irisa.fr",
    "download_url": "https://files.pythonhosted.org/packages/00/36/22cc1fa9bdcee6432310b43feebb685868a336f02d13e826f25f5692a99b/clearbot-0.2.0.tar.gz",
    "platform": null,
    "description": "# clearbot\n\nClearbit Logo API client.\n\n`clearbot` fetches the logo of company (png file) based on their domain name.\n\n## Install\n\nThe script in available through a python package.\n\n```shell\npip install clearbot\n```\n\n## Get started\n\nYou can run directly the script on a domain.\n\n```shell\nclearbot github.com\n```\n\nYou can pass several domains as well.\n\n```shell\nclearbot github.com gitlab.com\n```\n\nA file can also be used as input (one domain by line).\n\n```shell\nclearbot -f ./domains.txt\n```\n\nBy default it will output `/tmp/<DOMAIN>.png`. You can change the destination directory with the `-d` option.\n\n```shell\nclearbot -d . github.com\n```\n\nBy default it outputs 512px png file (i.e. the greatest side has 512px). You can change it with the `-s` option.\n\n```shell\nclearbot -s 128 github.com\n```\n\nSometimes 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).\n\n```shell\nclearbot -t 250 github.com\n```\n\n## What's next?\n\n- Add tests\n- Colorize image\n- Print result to the terminal\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Clearbit Logo API client",
    "version": "0.2.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "90ce7b62f4f83ecd200f169943bb5049964a4e8cc759bd3d9f558250433b3bcd",
                "md5": "4b0403db9ebbcf578dd64ba5ccb7f52a",
                "sha256": "43abbf27addd87eaf8a6fc0b25209333c04a60e0b4fc01363d926a9dbdbca7e3"
            },
            "downloads": -1,
            "filename": "clearbot-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4b0403db9ebbcf578dd64ba5ccb7f52a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 4484,
            "upload_time": "2023-02-03T09:30:43",
            "upload_time_iso_8601": "2023-02-03T09:30:43.210642Z",
            "url": "https://files.pythonhosted.org/packages/90/ce/7b62f4f83ecd200f169943bb5049964a4e8cc759bd3d9f558250433b3bcd/clearbot-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "003622cc1fa9bdcee6432310b43feebb685868a336f02d13e826f25f5692a99b",
                "md5": "934e5b2de0dbe2aa438ee2cc425fafdb",
                "sha256": "7ed93f854bea35d6badfb9e499b16fe18f0044cb6f8127f416bfad1bcc5f1628"
            },
            "downloads": -1,
            "filename": "clearbot-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "934e5b2de0dbe2aa438ee2cc425fafdb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 4221,
            "upload_time": "2023-02-03T09:30:44",
            "upload_time_iso_8601": "2023-02-03T09:30:44.574758Z",
            "url": "https://files.pythonhosted.org/packages/00/36/22cc1fa9bdcee6432310b43feebb685868a336f02d13e826f25f5692a99b/clearbot-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-03 09:30:44",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "clearbot"
}