Metadata-Version: 2.1
Name: imgkit
Version: 1.2.0
Summary: Wkhtmltopdf python wrapper to convert html to image using the webkit rendering engine and qt
Home-page: https://github.com/jarrekk/imgkit
Author: Jarrekk
Author-email: me@jarrekk.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/jarrekk/imgkit/issues
Description: # IMGKit: Python library of HTML to IMG wrapper
        
        [![Unit Test](https://github.com/jarrekk/imgkit/actions/workflows/unit_test.yml/badge.svg?branch=master)](https://github.com/jarrekk/imgkit/actions/workflows/unit_test.yml)
        [![codecov](https://codecov.io/gh/jarrekk/imgkit/branch/master/graph/badge.svg?token=pNl4TtuAzz)](https://codecov.io/gh/jarrekk/imgkit)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/aa1f67f04ff24bb080b7f8c8a9b7b8b1)](https://www.codacy.com/app/jarrekk/imgkit?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jarrekk/imgkit&amp;utm_campaign=Badge_Grade)
        [![Release](https://github.com/jarrekk/imgkit/actions/workflows/release.yml/badge.svg)](https://github.com/jarrekk/imgkit/actions/workflows/release.yml)
        [![PyPI version](https://badge.fury.io/py/imgkit.svg)](https://badge.fury.io/py/imgkit)
        
        ``` text
          _____   __  __    _____   _  __  _   _
         |_   _| |  \/  |  / ____| | |/ / (_) | |
           | |   | \  / | | |  __  | ' /   _  | |_
           | |   | |\/| | | | |_ | |  <   | | | __|
          _| |_  | |  | | | |__| | | . \  | | | |_
         |_____| |_|  |_|  \_____| |_|\_\ |_|  \__|
        
        ```
        
        Python 2 and 3 wrapper for wkhtmltoimage utility to convert HTML to IMG using Webkit.
        
        ## Installation
        
        1. Install imgkit:
        
            ``` python
            pip install imgkit
            ```
        
        2. Install wkhtmltopdf:
        
            * Debian/Ubuntu:
        
                ``` bash
                sudo apt-get install wkhtmltopdf
                ```
        
                **Warning!** Version in debian/ubuntu repos have reduced functionality (because it compiled without the wkhtmltopdf QT patches), such as adding outlines, headers, footers, TOC etc. To use this options you should install static binary from [wkhtmltopdf](http://wkhtmltopdf.org/) site or you can use this [script](https://github.com/jarrekk/imgkit/blob/master/travis/init.sh).
        
            * MacOSX:
        
                ``` bash
                brew install --cask wkhtmltopdf
                ```
        
            * Windows and other options:
        
                Check [wkhtmltopdf homepage](http://wkhtmltopdf.org/) for binary installers or [wiki page](https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF).
        
        ## Usage
        
        Simple example:
        
        ``` python
        import imgkit
        
        imgkit.from_url('http://google.com', 'out.jpg')
        imgkit.from_file('test.html', 'out.jpg')
        imgkit.from_string('Hello!', 'out.jpg')
        ```
        
        Also you can pass an opened file:
        
        ``` python
        with open('file.html') as f:
            imgkit.from_file(f, 'out.jpg')
        ```
        
        If you wish to further process generated IMG, you can read it to a variable:
        
        ``` python
        # Use False instead of output path to save pdf to a variable
        img = imgkit.from_url('http://google.com', False)
        ```
        
        You can find all wkhtmltoimage options by type `wkhtmltoimage` command or visit this [Manual](https://wkhtmltopdf.org/usage/wkhtmltopdf.txt). You can drop '--' in option name. If option without value, use *None, False* or *''* for dict value:. For repeatable options (incl. allow, cookie, custom-header, post, postfile, run-script, replace) you may use a list or a tuple. With option that need multiple values (e.g. --custom-header Authorization secret) we may use a 2-tuple (see example below).
        
        ``` python
        options = {
            'format': 'png',
            'crop-h': '3',
            'crop-w': '3',
            'crop-x': '3',
            'crop-y': '3',
            'encoding': "UTF-8",
            'custom-header' : [
                ('Accept-Encoding', 'gzip')
            ]
            'cookie': [
                ('cookie-name1', 'cookie-value1'),
                ('cookie-name2', 'cookie-value2'),
            ],
            'no-outline': None
        }
        
        imgkit.from_url('http://google.com', 'out.png', options=options)
        ```
        
        At some headless servers, perhaps you need to install **xvfb**:
        
        ``` bash
        # at ubuntu server, etc.
        sudo apt-get install xvfb
        # at centos server, etc.
        yum install xorg-x11-server-Xvfb
        ```
        
        Then use **IMGKit** with option **xvfb**: `{"xvfb": ""}`.
        
        By default, IMGKit will show all `wkhtmltoimage` output. If you don't want it, you need to pass `quiet` option:
        
        
        ``` python
        options = {
            'quiet': ''
            }
        
        imgkit.from_url('google.com', 'out.jpg', options=options)
        ```
        
        Due to wkhtmltoimage command syntax, **TOC** and **Cover** options must be specified separately. If you need cover before TOC, use `cover_first` option:
        
        ``` python
        toc = {
            'xsl-style-sheet': 'toc.xsl'
        }
        
        cover = 'cover.html'
        
        imgkit.from_file('file.html', options=options, toc=toc, cover=cover)
        imgkit.from_file('file.html', options=options, toc=toc, cover=cover, cover_first=True)
        ```
        
        You can specify external CSS files when converting files or strings using *css* option.
        
        ``` python
        # Single CSS file
        css = 'example.css'
        imgkit.from_file('file.html', options=options, css=css)
        
        # Multiple CSS files
        css = ['example.css', 'example2.css']
        imgkit.from_file('file.html', options=options, css=css)
        ```
        
        You can also pass any options through meta tags in your HTML:
        
        
        ``` python
        body = """
        <html>
          <head>
            <meta name="imgkit-format" content="png"/>
            <meta name="imgkit-orientation" content="Landscape"/>
          </head>
          Hello World!
          </html>
        """
        
        imgkit.from_string(body, 'out.png')
        ```
        
        ## Configuration
        
        Each API call takes an optional config paramater. This should be an instance of `imgkit.config()` API call. It takes the config options as initial paramaters. The available options are:
        
          * `wkhtmltoimage` - the location of the `wkhtmltoimage` binary. By default `imgkit` will attempt to locate this using which` (on UNIX type systems) or where` (on Windows).
          * `xvfb` - the location of the `xvfb-run` binary. By default `imgkit` will attempt to locate this using which` (on UNIX type systems) or where` (on Windows).
          * `meta_tag_prefix` - the prefix for `imgkit` specific meta tags - by default this is `imgkit-`
        
        Example - for when `wkhtmltopdf` or `xvfb` is not in `$PATH`:
        
        ``` python
        config = imgkit.config(wkhtmltoimage='/opt/bin/wkhtmltoimage', xvfb='/opt/bin/xvfb-run')
        imgkit.from_string(html_string, output_file, config=config)
        ```
        
        ## Troubleshooting
        
        * `IOError: 'No wkhtmltopdf executable found'`:
        
            Make sure that you have wkhtmltoimage in your `$PATH` or set via custom configuration (see preceding section). *where wkhtmltoimage* in Windows or *which wkhtmltoimage* on Linux should return actual path to binary.
        
        * `IOError: 'No xvfb executable found'`:
        
            Make sure that you have xvfb-run in your `$PATH` or set via custom configuration (see preceding section). *where xvfb* in Windows or *which xvfb-run* or *which Xvfb* on Linux should return actual path to binary.
        
        * `IOError: 'Command Failed'`:
        
            This error means that IMGKit was unable to process an input. You can try to directly run a command from error message and see what error caused failure (on some wkhtmltoimage versions this can be cause by segmentation faults)
        
        ## Credit
        
        [python PDFKit](https://github.com/JazzCore/python-pdfkit)
        
        ## IMGKit author
        
        * **jarrekk** <https://github.com/jarrekk>
        
        ### Contributors
        
        * **v-hunt** <https://github.com/v-hunt>
        * **archydeberker** <https://github.com/archydeberker>
        * **arayate** <https://github.com/arayate>
        * **xtrntr** <https://github.com/xtrntr>
        * **mike1703** <https://github.com/mike1703>
        * **themeewa** <https://github.com/themeewa>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: General
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Text Processing :: Markup :: XML
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
