Metadata-Version: 1.1
Name: imgkit
Version: 0.1.6
Summary: Wkhtmltopdf python wrapper to convert html to image using the webkit rendering engine and qt
Home-page: http://github.com/jarrekk/imgkit
Author: jarrekk
Author-email: me@jarrekk.com
License: MIT
Download-URL: https://github.com/jarrekk/imgkit
Description: IMGKit: Python library of HTML to IMG wrapper
        =============================================
        
        |Build Status| |Code Coverage| |Codacy Badge| |PyPI version|
        
        ::
        
              _____   __  __    _____   _  __  _   _
             |_   _| |  \/  |  / ____| | |/ / (_) | |
               | |   | \  / | | |  __  | ' /   _  | |_
               | |   | |\/| | | | |_ | |  <   | | | __|
              _| |_  | |  | | | |__| | | . \  | | | |_
             |_____| |_|  |_|  \_____| |_|\_\ |_|  \__|
        
        Python 2 and 3 wrapper for wkhtmltoimage utility to convert HTML to IMG
        using Webkit.
        
        Installation
        ------------
        
        1. Install imgkit:
        
           .. code:: python
        
               pip install imgkit
        
        2. Install wkhtmltopdf:
        
        -  Debian/Ubuntu:
        
           .. code:: 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
        
           .. code:: bash
        
               brew install 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:
        
        .. code:: python
        
            import imgkit
        
            imgkit.from_url('http://google.com', 'out.jpg')
            imgkit.from_file('test.html', 'out.jpg')
            imgkit.from_string('Hello!', 'out.jpg')
        
        You can pass a list with multiple URLs or files:
        
        .. code:: python
        
            imgkit.from_url(['google.com', 'yandex.ru', 'engadget.com'], 'out.jpg')
            imgkit.from_file(['file1.html', 'file2.html'], 'out.jpg')
        
        Also you can pass an opened file:
        
        .. code:: 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:
        
        .. code:: 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 <http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltoimage_0.10.0_rc2-doc.html>`__.
        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).
        
        .. code:: 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)
        
        By default, IMGKit will show all ``wkhtmltoimage`` output. If you don't
        want it, you need to pass ``quiet`` option:
        
        .. code:: 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:
        
        .. code:: 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.
        
        .. code:: 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:
        
        .. code:: 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).
        -  ``meta_tag_prefix`` - the prefix for ``imgkit`` specific meta tags -
           by default this is ``imgkit-``
        
        Example - for when wkhtmltopdf\ ``is not in $PATH``:
        
        .. code:: python
        
            config = imgkit.config(wkhtmltoimage='/opt/bin/wkhtmltoimage')
            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: '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
        ------
        
        This is library edited from `python
        PDFKit <https://github.com/JazzCore/python-pdfkit>`__
        
        .. |Build Status| image:: https://travis-ci.org/jarrekk/imgkit.svg?branch=master
           :target: https://travis-ci.org/jarrekk/imgkit
        .. |Code Coverage| image:: https://codecov.io/github/jarrekk/imgkit/branch/master/graph/badge.svg
           :target: https://codecov.io/github/jarrekk/imgkit/
        .. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/aa1f67f04ff24bb080b7f8c8a9b7b8b1
           :target: https://www.codacy.com/app/jarrekk/imgkit?utm_source=github.com&utm_medium=referral&utm_content=jarrekk/imgkit&utm_campaign=Badge_Grade
        .. |PyPI version| image:: https://badge.fury.io/py/imgkit.svg
           :target: https://badge.fury.io/py/imgkit
        
        IMGKit author
        -------------
        
        -  **jarrekk** https://github.com/jarrekk
        
        Contributors
        ~~~~~~~~~~~~
        
        -  **v-hunt** https://github.com/v-hunt
        -  **pprmint** https://github.com/pprmint
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
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
