summaryrefslogtreecommitdiffstats
path: root/python/python3-PyMuPDF/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-PyMuPDF/README')
-rw-r--r--python/python3-PyMuPDF/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/python/python3-PyMuPDF/README b/python/python3-PyMuPDF/README
new file mode 100644
index 0000000000..9a35043dd8
--- /dev/null
+++ b/python/python3-PyMuPDF/README
@@ -0,0 +1,24 @@
+PyMuPDF adds Python bindings and abstractions to MuPDF, a lightweight
+PDF, XPS, and eBook viewer, renderer, and toolkit. Both PyMuPDF and
+MuPDF are maintained and developed by Artifex Software, Inc.
+
+MuPDF can access files in PDF, XPS, OpenXPS, CBZ, EPUB and FB2 (eBooks)
+formats, and it is known for its top performance and exceptional
+rendering quality.
+
+With PyMuPDF you can access files with extensions like .pdf, .xps,
+.oxps, .cbz, .fb2 or .epub. In addition, about 10 popular image formats
+can also be handled like documents: .png, .jpg, .bmp, .tiff, etc.
+
+krop (available on SBo) can use PyMuPDF for both rendering and cropping.
+
+Mupdf is not a dependency because all of the necessary code is built
+into PyMuPDF.
+
+Optional runtime dependencies are python3-fonttools, tesseract, and
+python3-pymupdf_fonts.
+
+To enable Tesseract OCR functions in PyMuPDF, the software must be
+installed and the system environment variable TESSDATA_PREFIX must
+be defined as follows:
+export TESSDATA_PREFIX=/usr/share/tessdata