Metadata-Version: 2.1
Name: instantview
Version: 0.1.1
Summary: Delta Chat bot to take website screenshots
Author-email: adbenitez <adb@merlinux.eu>
Project-URL: Homepage, https://github.com/deltachat-bot/instantview
Keywords: deltachat,bot
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: deltabot-cli <7.0,>=6.2.0
Requires-Dist: beautifulsoup4 <5.0,>=4.12.3
Requires-Dist: html5lib <2.0,>=1.1
Requires-Dist: requests <3.0,>=2.32.3
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pylama ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'

# Instant View - Delta Chat Bot

[![Latest Release](https://img.shields.io/pypi/v/instantview.svg)](https://pypi.org/project/instantview)
[![CI](https://github.com/deltachat-bot/instantview/actions/workflows/python-ci.yml/badge.svg)](https://github.com/deltachat-bot/instantview/actions/workflows/python-ci.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A Delta Chat bot that allows to get website URLs previews as HTML messages

## Install

```sh
pip install instantview
```

## Usage

To configure the bot:

```sh
instantview-bot init bot@example.org SuperHardPassword
```

**(Optional)** To customize the bot name, avatar and status/signature:

```sh
instantview-bot config selfavatar "/path/to/avatar.png"
instantview-bot config displayname "Web Preview"
instantview-bot config selfstatus "Hi, send me some URL to get a preview"
```

Finally you can start the bot with:

```sh
instantview-bot serve
```

To see the available options, run in the command line:

```
instantview-bot --help
```
