Skip to main content

PDF generator using HTML and CSS

Project description

https://travis-ci.org/xhtml2pdf/xhtml2pdf.svg Coveralls https://badge.fury.io/py/xhtml2pdf.svg

This project is community-led! To strengthen it, please hang out on IRC #xhtml2pdf (Freenode) or join our maling list.

Call for testing

This project is heavily dependent on getting its test coverage up! Currently, Python 3 support is being worked on and many refactors and suggestions are potentially coming in. Furthermore, parts of the codebase could do well with cleanups and refactoring.

If you benefit from xhtml2pdf, perhaps look at the test coverage and identify parts that are yet untouched?

About

xhtml2pdf is a html2pdf converter using the ReportLab Toolkit, the HTML5lib and pyPdf. It supports HTML 5 and CSS 2.1 (and some of CSS 3). It is completely written in pure Python so it is platform independent.

The main benefit of this tool that a user with Web skills like HTML and CSS is able to generate PDF templates very quickly without learning new technologies.

Installation

This is a typical Python library and is installed using pip:

pip install xhtml2pdf

To obtain the latest experimental version that has Python 3 support, please use a prerelease:

pip install --pre xhtml2pdf

Requirements

Python 2.7+. Only Python 3.4+ is tested and guaranteed to work.

All additional requirements are listed in requirements.txt file and are installed automatically using the pip install xhtml2pdf method.

Development environment

  1. If you don’t have it, install pip, the python package installer:

    sudo easy_install pip

    For more information about pip refer to http://www.pip-installer.org/.

  2. I will recommend using virtualenv for development. This is great to have separate environment for each project, keeping the dependencies for multiple projects separated:

    sudo pip install virtualenv

    For more information about virtualenv refer to http://www.virtualenv.org/

  3. Create virtualenv for the project. This can be inside the project directory, but cannot be under version control:

    virtualenv --distribute xhtml2pdfenv --python=python2
  4. Activate your virtualenv:

    source xhtml2pdfenv/bin/activate

    Later to deactivate use:

    deactivate
  5. Next step will be to install/upgrade dependencies from requirements.txt file:

    pip install -r requirements.txt
  6. Run tests to check your configuration:

    nosetests --with-coverage

    You should have a log with success status:

    Ran 36 tests in 0.322s
    
    OK

Python integration

Some simple demos of how to integrate xhtml2pdf into a Python program may be found here: test/simple.py

Running tests

Two different test suites are available to assert xhtml2pdf works reliably:

  1. Unit tests. The unit testing framework is currently minimal, but is being improved on a daily basis (contributions welcome). They should run in the expected way for Python’s unittest module, i.e.:

    nosetests --with-coverage (or your personal favorite)
  2. Functional tests. Thanks to mawe42’s super cool work, a full functional test suite lives in testrender/.

Contact

History

This are the major milestones and the maintainers of the project:

  • 2000-2007, commercial project, spirito.de, written by Dirk Holtwich

  • 2007-2010 Dirk Holtwich (project named “Pisa”, project released as GPL)

  • 2010-2012 Dirk Holtwick (project named “xhtml2pdf”, changed license to Apache)

  • 2012-2015 Chris Glass (@chrisglass)

  • 2015- Benjamin Bach (@benjaoming)

For more history, see the CHANGELOG.

License

Copyright 2010 Dirk Holtwick, holtwick.it

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

xhtml2pdf-0.1a4.zip (115.4 kB view details)

Uploaded Source

xhtml2pdf-0.1a4.tar.gz (95.2 kB view details)

Uploaded Source

Built Distribution

xhtml2pdf-0.1a4-py3-none-any.whl (235.9 kB view details)

Uploaded Python 3

File details

Details for the file xhtml2pdf-0.1a4.zip.

File metadata

  • Download URL: xhtml2pdf-0.1a4.zip
  • Upload date:
  • Size: 115.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xhtml2pdf-0.1a4.zip
Algorithm Hash digest
SHA256 7515a65931309e392e062a2d496e986b2f54e061e08f963995c51d08fb4cef31
MD5 735febb51794dee99e81f31e6eb569e5
BLAKE2b-256 1c6754660d81221c3b8d302da89194caa313bcde8cc38244bf9a217d434e3d61

See more details on using hashes here.

File details

Details for the file xhtml2pdf-0.1a4.tar.gz.

File metadata

  • Download URL: xhtml2pdf-0.1a4.tar.gz
  • Upload date:
  • Size: 95.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xhtml2pdf-0.1a4.tar.gz
Algorithm Hash digest
SHA256 3d8d1edb70890d9c9a016a3ddbdcf6dd23cf49bab33ab55fe22b879df3390e92
MD5 beb2d99bb99376a3a4f584599eacec23
BLAKE2b-256 1c04a52a262a9ae6cd07b86baf2d9486d00da1dec5edf638cbe19c5983ebd266

See more details on using hashes here.

File details

Details for the file xhtml2pdf-0.1a4-py3-none-any.whl.

File metadata

File hashes

Hashes for xhtml2pdf-0.1a4-py3-none-any.whl
Algorithm Hash digest
SHA256 11b1bf40ecb09af8fe68885e5d143a6fa5a9e7f92b06c13b55354e566a6fcece
MD5 94772e606ee94ac8f344359c6186675e
BLAKE2b-256 68f1fc3170773250aa3aaee086e542ae9dd2ae80493b531768085baaf4d0d8c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page