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.24.tar.gz (54.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.24-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for html2pdf4doc-0.0.24.tar.gz
Algorithm Hash digest
SHA256 4de5b35e4bffbd2b8efde690f906d9278bf2c33aaad9a8df8104554a615f6e06
MD5 d53a223770d8dd0be72f2455d663ce0b
BLAKE2b-256 04e3a4b020ac56be54866fe641383f88ceea381fa1c8a36d3bd20a99004e6377

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for html2pdf4doc-0.0.24-py3-none-any.whl
Algorithm Hash digest
SHA256 f83182d1817203c5b425514b720e182ad797c0e6ee6fa4dc4e26cb32c994bc91
MD5 2c85250af51a016fdf13ecce30bed9df
BLAKE2b-256 19a2caa50065eeffd046c4261c463680689d5743ad4b948e9af635661955f71a

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