This is a Python package for using DocRaptor API to convert HTML to PDF and XLSX. It is compatible with Python 3.
pip install --upgrade docraptoror
easy_install --upgrade docraptorIf you are on a system with easy_install but not pip, you can use easy_install instead. If you're not using virtualenv, you may have to prefix those commands with sudo.
import docraptor
doc_api = docraptor.DocApi()
doc_api.api_client.configuration.username = 'YOUR_API_KEY_HERE' # this key works for test documents
# doc_api.api_client.configuration.debug = True
response = doc_api.create_doc({
"test": True, # test documents are free but watermarked
"document_content": "<html><body>Hello World</body></html>", # supply content directly
# "document_url": "http://docraptor.com/examples/invoice.html", # or use a url
"name": "docraptor-python.pdf", # help you find a document later
"document_type": "pdf", # pdf or xls or xlsx
# "javascript": True, # enable JavaScript processing
# "prince_options": {
# "media": "screen", # use screen styles instead of print styles
# "baseurl": "http://hello.com", # pretend URL when using document_content
# },
})- Optionally store and get a URL for your converted document with document hosting
- View more code examples with error handling, asynchronous creation, file saving, and document hosting.
- Perfect your document styling with our style and formatting reference, and API reference. Easily add headers and footers, page breaks, page numbers, table of contents, and much more!
Stuck? We're experts at turning HTML into PDFs so please email us if you run into trouble.
The majority of the code in this repo is generated using openapi-generator on docraptor.yaml. You can modify this file and regenerate the client using script/generate_language.
The generated client needed a few fixes
- Pull latest master
- Merge feature branch(es) into master
script/test- Increment version:
generator-config.json
- Run
script/generate_languageto update generated version numbers:
docraptor/__init__.pydocraptor/api_client.pydocraptor/configuration.pysetup.py
- Update CHANGELOG.md
- Commit "Release version vX.Y.Z"
- Push to GitHub
- Tag version:
git tag 'vX.Y.Z' && git push --tags script/release- Verify package release at https://pypi.python.org/pypi/docraptor
- Update documentation on docraptor.com
This library follows Semantic Versioning 2.0.0.