summaryrefslogtreecommitdiffstats
path: root/python/pikepdf/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/pikepdf/README')
-rw-r--r--python/pikepdf/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/python/pikepdf/README b/python/pikepdf/README
new file mode 100644
index 0000000000..f164e09bb8
--- /dev/null
+++ b/python/pikepdf/README
@@ -0,0 +1,10 @@
+Pikepdf is a Python library for reading and writing PDF files.
+It is based on QPDF, a powerful PDF manipulation and repair
+library. This library is similar to PyPDF2 and pdfrw - it provides
+low level access to PDF features and allows editing and content
+transformation of existing PDFs. Some knowledge of the PDF
+specification may be helpful. It does not have the capability to
+render a PDF to image.
+
+A whole slew of extra dependencies is needed for building the docs.
+To minimize the dependency list, this build script will not do this.