Metadata-Version: 1.1
Name: python-pdf
Version: 0.3
Summary: PDF generation in python using wkhtmltopdf suitable for heroku
Home-page: https://github.com/tutorcruncher/pydf
Author: Samuel Colvin
Author-email: S@muelColvin.com
License: MIT
Description: pydf
        ====
        
        
        |Build Status| |codecov.io| |PyPI Status| |license|
        
        PDF generation in python using
        `wkhtmltopdf <http://wkhtmltopdf.org/>`__.
        
        Wkhtmltopdf binaries are precompiled and included in the package making
        pydf easier to use, in particular this means pydf works on heroku.
        
        Currently using **wkhtmltopdf 0.12.4 (with patched qt)**.
        
        Install
        -------
        
        ::
        
            pip install python-pdf
        
        (pydf was taken, but I guess python-pdf is a clearer name anyway.)
        
        Basic Usage
        -----------
        
        .. code:: python
        
            import pydf
            pdf = pydf.generate_pdf('<h1>this is html</h1>')
            with open('test_doc.pdf', 'w') as f:
                f.write(pdf)
        
            pdf = pydf.generate_pdf('www.google.com')
            with open('google.pdf', 'w') as f:
                f.write(pdf)
        
        API
        ---
        
        **generate\_pdf(source, [\*\*kwargs])**
        
        Generate a pdf from either a url or a html string.
        
        After the html and url arguments all other arguments are passed straight
        to wkhtmltopdf
        
        For details on extra arguments see the output of get\_help() and
        get\_extended\_help()
        
        All arguments whether specified or caught with extra\_kwargs are
        converted to command line args with
        ``'--' + original_name.replace('_', '-')``.
        
        Arguments which are True are passed with no value eg. just --quiet,
        False and None arguments are missed, everything else is passed with
        str(value).
        
        **Arguments:**
        
        -  ``source``: html string to generate pdf from or url to get
        -  ``quiet``: bool
        -  ``grayscale``: bool
        -  ``lowquality``: bool
        -  ``margin_bottom``: string eg. 10mm
        -  ``margin_left``: string eg. 10mm
        -  ``margin_right``: string eg. 10mm
        -  ``margin_top``: string eg. 10mm
        -  ``orientation``: Portrait or Landscape
        -  ``page_height``: string eg. 10mm
        -  ``page_width``: string eg. 10mm
        -  ``page_size``: string: A4, Letter, etc.
        -  ``image_dpi``: int default 600
        -  ``image_quality``: int default 94
        -  ``extra_kwargs``: any exotic extra options for wkhtmltopdf
        
        Returns string representing pdf
        
        **get\_version()**
        
        Get version of pydf and wkhtmltopdf binary
        
        **get\_help()**
        
        get help string from wkhtmltopdf binary uses -h command line option
        
        **get\_extended\_help()**
        
        get extended help string from wkhtmltopdf binary uses -H command line
        option
        
        **execute\_wk(\*args)**
        
        Low level function to call wkhtmltopdf, arguments are added to
        wkhtmltopdf binary and passed to subprocess with not processing.
        
        Changelog
        ---------
        
        0.3
        ~~~
        
        -  uprev wkhtmltopdf from **0.12.2 (beta)** to **0.12.4**.
        -  code cleanup
        
        0.21
        ~~~~
        
        - correct permissions on wkhtmltopdf binary.
        
        .. |Build Status| image:: https://travis-ci.org/tutorcruncher/pydf.svg?branch=master
           :target: https://travis-ci.org/tutorcruncher/pydf
        .. |codecov.io| image:: https://codecov.io/github/tutorcruncher/pydf/coverage.svg?branch=master
           :target: https://codecov.io/github/tutorcruncher/pydf?branch=master
        .. |PyPI Status| image:: https://img.shields.io/pypi/v/python-pdf.svg?style=flat
           :target: https://pypi.python.org/pypi/python-pdf
        .. |license| image:: https://img.shields.io/pypi/l/python-pdf.svg
           :target: https://github.com/tutorcruncher/pydf
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
