https://github.com/incuna/django-wkhtmltopdf

Django Wrapper to the PDF Renderer: wkhtmltopdf
https://github.com/incuna/django-wkhtmltopdf

Last synced: 10 days ago
JSON representation

Django Wrapper to the PDF Renderer: wkhtmltopdf

• Host: GitHub
• URL: https://github.com/incuna/django-wkhtmltopdf
• Owner: incuna
• License: bsd-2-clause
• Created: 2012-02-23T15:11:31.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T20:01:17.000Z (almost 2 years ago)
• Last Synced: 2024-09-23T22:48:27.109Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 237 KB
• Stars: 326
• Watchers: 31
• Forks: 155
• Open Issues: 41
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
django-wkhtmltopdf

==================

.. image:: https://badge.fury.io/py/django-wkhtmltopdf.png

    :target: http://badge.fury.io/py/django-wkhtmltopdf

    :alt: Latest version

.. image:: https://travis-ci.org/incuna/django-wkhtmltopdf.png?branch=master

   :target: https://travis-ci.org/incuna/django-wkhtmltopdf

   :alt: Travis-CI

.. image:: https://img.shields.io/pypi/dm/django-wkhtmltopdf.svg

    :target: https://badge.fury.io/py/django-wkhtmltopdf

    :alt: Number of PyPI downloads on a month

Converts HTML to PDF

--------------------

Provides Django views to wrap the HTML to PDF conversion of the `wkhtmltopdf `_ binary.

Requirements

------------

Install the `wkhtmltopdf static binary `_.

This requires libfontconfig (on Ubuntu: ``sudo aptitude install libfontconfig``).

Python 2.6+ and 3.3+ are supported.

Installation

------------

Run ``pip install django-wkhtmltopdf``.

Add ``'wkhtmltopdf'`` to ``INSTALLED_APPS`` in your ``settings.py``.

By default it will execute the first ``wkhtmltopdf`` command found on your ``PATH``.

If you can't add wkhtmltopdf to your ``PATH``, you can set ``WKHTMLTOPDF_CMD`` to a

specific executable:

e.g. in ``settings.py``: ::

    WKHTMLTOPDF_CMD = '/path/to/my/wkhtmltopdf'

or alternatively as env variable: ::

    export WKHTMLTOPDF_CMD=/path/to/my/wkhtmltopdf

You may also set ``WKHTMLTOPDF_CMD_OPTIONS`` in ``settings.py`` to a dictionary

of default command-line options.

The default is: ::

    WKHTMLTOPDF_CMD_OPTIONS = {

        'quiet': True,

    }

Documentation

-------------

Documentation is available at http://django-wkhtmltopdf.readthedocs.org/en/latest/.

License

-------

MIT licensed. See the bundled `LICENSE `_ file for more details.