Code Monkey home page Code Monkey logo

django-xhtml2pdf's Introduction

XHTML2PDF

PyPI version Python versions Coveralls Read the Docs

Release Notes can be found here: Release Notes As 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 thanks to everyone who has worked on this project so far and to those who help maintain it.

About

xhtml2pdf 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 using Patreon or Bitcoins: bc1qmr0skzwx5scyvh2ql28f7gfh6l65ua250qv227

Documentation

The documentation of xhtml2pdf is available at Read the Docs.

And we could use your help improving it! A good place to start is doc/source/usage.rst.

Installation

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

pip install xhtml2pdf

Requirements

Only Python 3.8+ is tested and guaranteed to work.

All mandatory requirements are listed in the pyproject.toml file and are installed automatically using the pip install xhtml2pdf method.

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 the reportlab docs.

The recommended choice is the cairo graphics library which has to be installed system-wide e.g. via the OS package manager in combination with the PyCairo extra dependency:

pip install xhtml2pdf[pycairo]

Alternatively, the legacy RenderPM can be used by installing:

pip install xhtml2pdf[renderpm]

Alternatives

You can try WeasyPrint. The codebase is pretty, it has different features and it does a lot of what xhtml2pdf does.

Call for testing

This 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 the test coverage and identify parts that are yet untouched.

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. We will recommend using venv for development.

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

    python -m venv .venv
    
  4. Activate your virtual environment:

    source .venv/bin/activate
    

    Later to deactivate it use:

    deactivate
    
  5. The next step will be to install/upgrade dependencies from the pyproject.toml file:

    pip install -e .[test,docs,build]
    
  6. Run tests to check your configuration:

    tox
    

    You should have a log with the following success status:

    congratulations :) (75.67 seconds)
    

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 that xhtml2pdf works reliably:

  1. 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.:

    tox
    
  2. Functional tests. Thanks to mawe42's super cool work, a full functional test suite is available at testrender/.

You can run them using make

make test       # run tests
make test-ref   # generate reference data for testrender
make test-all   # Run all test using tox

Contact

This project is community-led! Feel free to open up issues on GitHub about new ideas to improve xhtml2pdf.

History

These 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 the Release Notes.

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.

django-xhtml2pdf's People

Contributors

beniwohli avatar chrisglass avatar cro avatar jensadne avatar luisza avatar ojii avatar vierno avatar xgvargas avatar yuce avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

django-xhtml2pdf's Issues

font error

I am using windows
in the template file I added
@font-face {font-family: RTLFont; src: url('F:\projs\app_name\app\static\app\fonts\markazi-reg.ttf')}
I get this error Can't open file "C:\Users\user\AppData\Local\Temp\tmpizpstnrs.ttf"
when I go to the file location I find the file but I get an error when I try to open it -> is not a valid font file
but the I can open file in it's original source

Can't generate multiple pages

I have one template test.html which contains 4 pages and separate by <pdf:nextpage />.

But it only generate one pages.
Using xhtml2pdf -s test.html that have same content with django template give me success result (multiple pages )

Any clue ?

fetch_resources does not work with urlencoded uri

For some reason the uri i get in fetch_resources is urlencoded so it does not work. It does not look like it is a common issue for other people but i'm just calling foo.url in the django template.

Trouble with images

Passing an entire object to view context and putting in it to the html that goes to pdf, i'm trying to get an image. Thats the view :

def customer_reader_pdf_view(request,*args,**kwargs):
    pk = kwargs.get('pk')
    customer = get_object_or_404(Customer, pk=pk)
    
    template_path = 'users/pdf_customer.html'
    context = {'customer': customer }       
        ...
    ```
But in the html wen i try to get the image passing the url : 

<img src="{{ customer.logo.url }}" heigth="200px">

Traceback (most recent call last):
File "/home/marcus_andrade/Desktop/pyp/Django_PDF/venv/lib/python3.8/site-packages/xhtml2pdf/context.py", line 773, in _getFileDeprecated
nv = self.pathCallback(name, relative)
TypeError: 'str' object is not callable
Need a valid file name!


I get the url, but it broke my code ... someone could help me ?

Specify font

Hello,
how would I specify the font? I've managed to put the page into PDF, but a lot of characters are not displayed correctly, I guess this is related to font character set?

staticfiles management in debug mode

Hi,

I like your work on xhtml2pdf, but it lacks a proper way to use django.staticfiles application to perform static resolution, through app_name/static folders.
In that case, files are NOT uin the STATIC_ROOT folder in dev environment.

I'll try to create a patch for this.

ImportError: No module named 'StringIO' on Python 3.6

Good afternoon, I used the library with Python 2.7 and had to move to version 3.6.1 and because of that it stopped working. After that I noticed a problem with an import in the utils.py file and the solution seems to be a simple fix.

Problem:
ImportError: No module named 'StringIO'

Solution:
Change 'import StringIO' to 'from io import StringIO'

Is it possible to verify and correct this problem?
Thanks for listening

Images...

I got this installed and partially working!

I can't seem to get images to appear.

Do you have any tips for debugging?

Thanks,
Shige

Cannot import name inputstream

Good evening,
Used django-xhtml2pdf in my application, until a few weeks ago on a windows machine 7. Unfortunately my machine spoiled and had to buy another that came with Windows 10, all the rest has been operating normally except the part print PDF. The error has shown is this:

Django Version: 1.9.7
Exception Type: ImportError
Exception Value: Can not import name inputstream

Exception Location: C: \ python27 \ lib \ site-packages \ xhtml2pdf \ parser.py in , line 17
Python Executable: C: \ python27 \ python.exe
Python Version: 2.7.12

The line where the error occurs is in this file: C: \ python27 \ lib \ site-packages \ xhtml2pdf \ parser.py in

In this line:
from html5lib import treebuilders, inputstream

I thought it could be some incompatibility with Windows 10 but I tested the project in a Linux environment and the same error occurs in exactly the same way.

Unfortunately google only helped me translating this text, almost did not think anything about something relevant to help solve this problem. I do not know if that might be the problem and apologize here not be the right place to share it. Being a bug or not is the record of someone who went through this problem and that seeking a solution ..

I think I may have to do with changing versions of a component installed with xthml2pdf but not sure ..

Once again I apologize for the inconvenience and thank you from of attention.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.