Skip to main content

PDF generator using HTML and CSS

Project description

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. PyPDF2 1.19+ (optional)

    All requirements are listed in requirements.txt 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.txt file:

    pip install -r requirements.txt
  7. 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

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.

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.0.6.zip (120.7 kB view details)

Uploaded Source

xhtml2pdf-0.0.6.tar.gz (100.6 kB view details)

Uploaded Source

File details

Details for the file xhtml2pdf-0.0.6.zip.

File metadata

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

File hashes

Hashes for xhtml2pdf-0.0.6.zip
Algorithm Hash digest
SHA256 7ee8ad104eeae5df73a43c66804cc347baf366c9ef3c7488de2f04bd4282af43
MD5 338d15dd13746b24eac625bc5fe45dc1
BLAKE2b-256 2e1f8cad2f493b1a77c06480b535aeb53198ab2142e9d9947a8a27c4beed0f85

See more details on using hashes here.

File details

Details for the file xhtml2pdf-0.0.6.tar.gz.

File metadata

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

File hashes

Hashes for xhtml2pdf-0.0.6.tar.gz
Algorithm Hash digest
SHA256 29dbf7da8943ccef4afb958747cd0084762821546e3cc62d23115fd7470d95f0
MD5 dee3703f768efcba26eab81a4207c2c8
BLAKE2b-256 ad45fb41eb8e766b7ef50a0db0893b71ff90d27ff1a9c76a0164bdbec37f4e84

See more details on using hashes here.

Supported by

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