As a rule of thumb, subfolders are named <action-object> as if pointing out an action to be performed on an object or set of objects, e.g. attach-images. Python scripts are named <action.py>, e.g. attach.py. Input filenames are called input, e.g. input.pdf while output filenames are called output, e.g. output.pdf.
Thus, the attach.py script in the attach-images folder is meant to attach the images in attach-images/input to a new document.
cd attach-images
python attach.py
For further information on how to run a particular example please read the documentation section at the beginning of each script.
| Folder | File | Description |
|---|---|---|
anonymize-document |
anonymize.py |
Remove all text from a document. |
attach-images |
attach.py |
Attach the images in the input directory to a new document. |
browse-document |
browse.py |
Display a document using Tkinter. |
combine-pages |
combine.py |
Copy a PDF document combining every 4 pages. |
convert-text |
convert.py |
A basic text-to-PDF converter. |
copy-embedded |
copy.py |
Copy the embedded files in the input document to the output document. |
display-document |
display.py |
Let the user select a document to scroll through it. |
draw-cardioid |
draw.py |
Draw a cardioid. |
draw-caustic |
draw.py |
Draw a caustic curve. |
draw-fractal |
carpet.py |
Draw the Sierpinski carpet fractal. |
draw-fractal |
punch.py |
Draw the Sierpinski carpet fractal. |
draw-fractal |
triangle.py |
Draw the Sierpinski triangle fractal. |
draw-sines |
draw.py |
Draw the sine and cosine functions. |
edit-images |
edit.py |
Edit images in a PDF document. |
edit-links |
edit.py |
Edit links in a PDF document. |
edit-toc |
edit.py |
Edit the table of contents (ToC) of a document. |
embed-images |
embed.py |
Embed the images found in the input directory. |
export-embedded |
export.py |
Export an embedded file from the input document to the output document. |
export-metadata |
export.py |
Export a document metadata dictionary to a CSV file. |
export-toc |
export.py |
Export the table of contents (ToC) of a document to a CSV file. |
extract-images |
extract-from-pages.py |
Extract the images of a document into the output folder. |
extract-images |
extract-from-xref.py |
Extract the images of a document into the output folder. |
extract-table |
extract.py |
CLI program to extract tables. |
extract-table |
wx-extract.py |
Browse a document with a wxPython GUI to extract tables. |
extract-xobj |
extract.py |
Scan a document and store the embedded XObjects as pages in a new document. |
import-embedded |
import.py |
Import a file to a document. |
import-metadata |
import.py |
Import a metadata dictionary from a CSV file into a PDF document. |
import-toc |
import.py |
Import a table of contents (ToC) from a CSV file into a PDF document. |
insert-images |
insert.py |
Create a PDF document by inserting the images found in the input directory. |
join-documents |
join.py |
Create a PDF document by inserting the images in the input directory. |
list-embedded |
list.py |
Print a list of embedded files in a document. |
make-calendar |
make.py |
Create a calendar with three years in a row. |
optimize-document |
optimize.py |
Optimize a PDF document with FileOptimizer. |
posterize-document |
posterize.py |
Create a PDF copy with split-up pages. |
print-hsv |
print.py |
Create a document showing RGB colors based on hue, saturation and value (HSV). |
print-page-format |
print.py |
Print the paper size given a width and height. |
print-rgb |
print.py |
Create a document showing RGB colors. |
replace-image |
remove.py |
Remove an image identified by xref. |
replace-image |
replace.py |
Replace an image identified by xref. |
split-document |
split.py |
Split a PDF document into multiple pages (1 per page). |
test-blendmode |
test.py |
Generate highlight annotations using blend modes. |
zerofy-rotation |
zerofy-rotation.py |
Set page rotation to 0 without changing appearance. |
Described below are the input files that have been used in the examples to create PDF, XPS files and eBooks with PyMuPDF.
| Title | Author | Publisher | License |
|---|---|---|---|
| Fluffy cockapoo having the time of his life at the park | Joe Caione | Unsplash | Unsplash |
| Made with Creative Commons | Paul Stacey and Sarah Hinchliff Pearson | Creative Commons | CC BY-SA 4.0 |
| Silver tabby cat photo | Erik-Jan Leusink | Unsplash | Unsplash |
| Think Python, 2nd ed. for Python 3 | Allen Downey | O'Reilly Media | CC BY-NC 3.0 |
Contributions are more than welcome. If you find a bug or just want to give some feedback, please let us know by opening an issue or sending a PR. We'll be happy to review the code and merge it into the codebase. Thank you.