Package: xhtml2pdf
XHTML2PDFRelease Notes can be found here:Release NotesAs with all open-source software, its use in production depends on many factors, so be aware that you may find issues in some cases.Big thanksto everyone who has worked on this project so far and to those who help maintain it.Aboutxhtml2pdf is a HTML to PDF converter using Python, the ReportLab Toolkit, html5lib and pypdf. It supports HTML5 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 is that a user with web skills like HTML and CSS is able to generate PDF templates very quickly without learning new technologies.Please consider support this project usingPatreonor Bitcoins:bc1qmr0skzwx5scyvh2ql28f7gfh6l65ua250qv227DocumentationThe documentation of xhtml2pdf is available atRead the Docs.And we could use your help improving it! A good place to start isdoc/source/usage.rst.InstallationThis is a typical Python library and can be installed using pip:pip install xhtml2pdfRequirementsOnly Python 3.8+ is tested and guaranteed to work.All mandatory requirements are listed in thepyproject.tomlfile and are installed automatically using thepip install xhtml2pdfmethod.As PDF library we depend on reportlab, which needs a rendering backend to generate bitmaps and vector graphic formats.
For more information about this, have a look at thereportlab docs.The recommended choice is thecairo graphics librarywhich has to be installed system-wide e.g. via the OS package manager
in combination with thePyCairoextra dependency:pip install xhtml2pdf[pycairo]Alternatively, the legacyRenderPMcan be used by installing:pip install xhtml2pdf[renderpm]AlternativesYou can tryWeasyPrint. The codebase is pretty, it has different features and it does a lot of what xhtml2pdf does.Call for testingThis project is heavily dependent on getting its test coverage up! Furthermore, parts of the codebase could do well with cleanups and refactoring.If you benefit from xhtml2pdf, perhaps look at thetest coverageand identify parts that are yet untouched.Development environmentIf you don’t have it, installpip, the python package installer:sudo easy_install pipFor more information aboutpiprefer tohttp://www.pip-installer.orgWe will recommend usingvenvfor development.Create a virtual environment for the project. This can be inside the project directory, but cannot be under version control:python -m venv .venvActivate your virtual environment:source .venv/bin/activateLater to deactivate it use:deactivateThe next step will be to install/upgrade dependencies from thepyproject.tomlfile:pip install -e .[test,docs,build]Run tests to check your configuration:toxYou should have a log with the following success status:congratulations :) (75.67 seconds)Python integrationSome simple demos of how to integrate xhtml2pdf into a Python program may be found here:test/simple.pyRunning testsTwo different test suites are available to assert that xhtml2pdf works reliably:Unit tests. The unit testing framework is currently minimal, but is being
improved on a regular basis (contributions welcome). They should run in the
expected way for Python’s unittest module, i.e.:toxFunctional tests. Thanks to mawe42’s super cool work, a full functional
test suite is available attestrender/.You can run them using makemaketest# run testsmaketest-ref# generate reference data for testrendermaketest-all# Run all test using toxContactThis project is community-led! Feel free to open up issues on GitHub about new ideas to improve xhtml2pdf.HistoryThese are the major milestones and the maintainers of the project:2000-2007 Dirk Holtwick (commercial project of spirito.de)2007-2010 Dirk Holtwick (project named “pisa”, project released as GPL)2010-2012 Dirk Holtwick (project named “xhtml2pdf”, changed license to Apache)2012-2015 Chris Glass (@chrisglass)2015-2016 Benjamin Bach (@benjaoming)2016-2018 Sam Spencer (@LegoStormtroopr)2018-Current Luis Zarate (@luisza)For more history, see theRelease Notes.LicenseCopyright 2010 Dirk Holtwick, holtwick.itLicensed 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.0Unless 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.