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.30.tar.gz (56.8 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.30-py3-none-any.whl (58.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: html2pdf4doc-0.0.30.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.20

File hashes

Hashes for html2pdf4doc-0.0.30.tar.gz
Algorithm Hash digest
SHA256 a2f17f307705d0f3b677a382aeb1e33850d8e2e75b879b759ca96427ad180dda
MD5 3441b147294f8ca615547cf75268580c
BLAKE2b-256 e8ea3634d976ab7f8cab7008376a84fbb4c48537922e838d2ba8678d2d6bbddd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: html2pdf4doc-0.0.30-py3-none-any.whl
  • Upload date:
  • Size: 58.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.20

File hashes

Hashes for html2pdf4doc-0.0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 8d6e8d59ba3a60685381f5476c18d58558f7a3c3268281c1e6e42a34d76a2760
MD5 67dfdc5ab1662e1ca39a392583e34d3d
BLAKE2b-256 aec57a60c2f3080e33e09fa5a64678f8e974b676977d8db231baf34f16e8917c

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