Skip to main content

xhtml2pdf

THIS PROJECT WAS INHERITED BY NECESSITY - PLEASE DO NOT CONTACT ME DIRECTLY FOR HELP BUT USE THE MAILING LIST INSTEAD.

I picked up the code because I needed to patch it, and nobody was around to merge my pull requests in. So now I can merge pull requests in, but I did not write the code.

If you think you can do a better job maintaing this project, feel free to let me know and I’ll give you commit rights (or ownership, or whatever).

Thanks!

HTML/CSS to PDF converter based on Python

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.

Requirements

  1. Reportlab Toolkit 2.2+

  2. html5lib 0.11.1+

  3. pyPdf 1.11+ (optional)

    All requirements are listed in requirements.xml file.

Development environment

Python, virtualenv and dependencies

  1. Install Python 2.6.x or 2.7.x. Installation steps depends on your operating system.

  2. Install Pip, the python package installer:

    sudo easy_install pip

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

  3. 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/

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

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

    source xhtml2pdfenv/bin/activate

    Later to deactivate use:

    deactivate
  6. Next step will be to install/upgrade dependencies from requirements.xml file:

    pip install -r requirements.xml
  7. Run tests to check your configuration:

    nosetests --with-coverage

    You should have a log with success status:

    Ran 35 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

Contributing

Development for this software happend on github, and the main fork is currently at https://github.com/chrisglass/xhtml2pdf

Contributions are welcome in any format, but using github’s pull request system is very highly preferred since it makes review and integration much easier.

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

Maintainer: Chris Glass <tribaal@gmail.com>

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.

Release files for xhtml2pdf 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distributions (sdists)

Source distribution for xhtml2pdf 0.0.5
File Size Uploaded
xhtml2pdf-0.0.5.zip 119.0 kB Details
xhtml2pdf-0.0.5.tar.gz 97.4 kB Details

Release files / xhtml2pdf-0.0.5.zip

Download URL xhtml2pdf-0.0.5.zip
Size 119.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f419e1a4c529872e1ccf7da3c2c3406613dd3be764eae56d66f5889a06cbaa64
BLAKE2b-256 checksum
How to use checksums
a969a068877d701d16f3fe9af162cfcadc24120319d5bea4528331aa46230143
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / xhtml2pdf-0.0.5.tar.gz

Download URL xhtml2pdf-0.0.5.tar.gz
Size 97.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1f108c09d0939025069e71e099ec88fb477076bdc781e54215d28a8d42fe5868
BLAKE2b-256 checksum
How to use checksums
ccefbefc3b66cff25e1c7a9b97562894b9005a0203a65082f2f214bd7d6c8527
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.2.26

2 release files

0.2.25

2 release files

0.2.24

2 release files

0.2.21

2 release files

0.2.20

2 release files

0.2.19

2 release files

0.2.17

2 release files

0.2.14

2 release files

0.2.11

1 release file

0.2.10

1 release file

0.2.9

1 release file

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2

1 release file

0.0.6

2 release files

This release

0.0.5 This release

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

0.0.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page