From 6286ebc7f6eab520783fe21ee5619bb33f5f3d7f Mon Sep 17 00:00:00 2001 From: humorhenker Date: Fri, 7 Apr 2023 20:05:36 +0200 Subject: [PATCH] extended readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2b001c4..a360654 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,25 @@ # mlwerke2pdf -Python module to convert texts on http://www.mlwerke.de into pdfs +Python module to convert texts on http://www.mlwerke.de into Portable Document Format files + +mlwerke2pdf fetches the linked subsites from the given table of contents and concats them to a single pdf + +at this point links and linked images in the pdf are not functional as they point to the mlwerke html structure +converting them to pdf internal links would be possible but rather complex -it this point links in the pdf are not functional as they point to the mlwerke html structure # dependencies -as pdfkit uses wkhtmltopdf you will need it +as pdfkit uses wkhtmltopdf you will need it. See https://pypi.org/project/pdfkit/ for instructions # Usage ## create MLWerke Object: mlwerk = mlwerke2pdf.MLWerk(URL) -use the base of a text like http://www.mlwerke.de/me/me04/me04_459.htm as URL +use the base / table of contents of a text like http://www.mlwerke.de/me/me04/me04_459.htm as URL ## generate a pdf -mlwerk.text2pdf(PDF_OUTPUT_PATH) \ No newline at end of file +mlwerk.text2pdf(PDF_OUTPUT_PATH) + +## or cominded into one line +mlwerke2pdf.MLWerk(URL).text2pdf(PDF_OUTPUT_PATH) \ No newline at end of file