Skip to main content

Python client for HTML2PDF4Doc JavaScript library.

Project description

html2pdf4doc_python

html2pdf4doc_python is the Python wrapper/CLI for the html2pdf4doc JavaScript library that prints HTML pages into PDFs using Chrome/Chromedriver.

This repository focuses strictly on the Python-side automation layer. The rendering logic remains in the JS core.

Installation

  1. Install Google Chrome (or Chrome for Testing) on the machine that will run the CLI.

  2. Install the package from PyPI:

pip install html2pdf4doc

Python 3.8+ is required.

See also: the Ubuntu-based container Dockerfile and the GitHub CI files found in the .github/workflows folder.

Usage

TBD

Developer guide

Getting started

1. (Optional) Create and activate a virtual environment

python -m venv .venv && source .venv/bin/activate

2. Install the dependencies

git clone https://github.com/strictdoc-project/html2pdf4doc_python.git
cd html2pdf4doc_python

# Bootstrap minimal Python dependencies: Invoke and TOML.
pip install invoke toml

# Install all Python dependencies and update the submodule with the html2pdf4doc.js.
invoke bootstrap

3. The JS library is maintained in a Git submodule submodules/html2pdf.

When the submodule is updated after a release or during the development, rebuild the JS library, i.e., regenerate the html2pdf4doc.min.js:

invoke build

4. To validate changes, use the following commands:

invoke lint
invoke test  # Normal tests.
invoke test-fuzz  # More robust testing.

License

The project is distributed under the Apache License 2.0 (see LICENSE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

html2pdf4doc-0.0.31.tar.gz (58.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

html2pdf4doc-0.0.31-py3-none-any.whl (60.6 kB view details)

Uploaded Python 3

File details

Details for the file html2pdf4doc-0.0.31.tar.gz.

File metadata

  • Download URL: html2pdf4doc-0.0.31.tar.gz
  • Upload date:
  • Size: 58.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for html2pdf4doc-0.0.31.tar.gz
Algorithm Hash digest
SHA256 209fe15ff68e4858fb9ed1159f7eafa921add8a915a676a1ad508b2d493ecff9
MD5 ad394b96a890f0ff1d1ed61db37cd801
BLAKE2b-256 acd2dfbc3fc96fc1daff146d34b1a03a8db520d0f6b508f714cdce6e27445f94

See more details on using hashes here.

File details

Details for the file html2pdf4doc-0.0.31-py3-none-any.whl.

File metadata

  • Download URL: html2pdf4doc-0.0.31-py3-none-any.whl
  • Upload date:
  • Size: 60.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for html2pdf4doc-0.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 3186a7317bfcaa294d878f8ae16183d5e14188c3165cf276aaec73df12d6db2f
MD5 dd8d1ab570ca5c9b24fdb63e61574947
BLAKE2b-256 24036b5cd964c3d747999b557fe075d28fe18afa00a4af8e50ce1bec7dd4adaa

See more details on using hashes here.

Supported by

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