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.23.tar.gz (54.2 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.23-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: html2pdf4doc-0.0.23.tar.gz
  • Upload date:
  • Size: 54.2 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.23.tar.gz
Algorithm Hash digest
SHA256 5c36dfe784c04d5621136e8d214aa7cfbdb14cb07549b29cb987020f51c7d440
MD5 749f7ca9189927fcfaa19dc7c1672373
BLAKE2b-256 eca3063348028b1e516a0fe3a859e5763052d65df2cd3d07d9bbaf8d2145f643

See more details on using hashes here.

File details

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

File metadata

  • Download URL: html2pdf4doc-0.0.23-py3-none-any.whl
  • Upload date:
  • Size: 56.3 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.23-py3-none-any.whl
Algorithm Hash digest
SHA256 b6fa9ca34700d53e83a4873236ca1d3384abf8e746fa931d1774d485ec237dd3
MD5 e37d05ffff558286def7cffca9abde03
BLAKE2b-256 09db97d4ee731af67742a3c8b2ee7889040e74e5daf2c87712efffae3616d1b8

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