1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
.. include:: header.rst
.. _pymupdf-pro
PyMuPDF Pro
=============
|PyMuPDF Pro| is a set of *commercial extensions* for |PyMuPDF|.
Enhance |PyMuPDF| capability with **Office** document support & **RAG/LLM** integrations.
- Enables Office document handling, including ``doc``, ``docx``, ``hwp``, ``hwpx``, ``ppt``, ``pptx``, ``xls``, ``xlsx``, and others.
- Supports text and table extraction, document conversion and more.
- Includes the commercial version of |PyMuPDF4LLM|.
To enquire about obtaining a commercial license, then `use this contact page <https://artifex.com/contact/>`_.
.. note::
A licensed version of |PyMuPDF Pro| also gives you a licensed version of |PyMuPDF4LLM|. If you are interested in using the |PyMuPDF4LLM| package you should install it separately.
Platform support
--------------------
Available for these platforms only:
- Windows x86_64.
- Linux x86_64 (glibc).
- MacOS x86_64.
- MacOS arm64.
Office file support
----------------------
In addition to the `standard file types supported by PyMuPDF <Supported_File_Types>`, |PyMuPDF Pro| supports:
.. list-table::
:header-rows: 1
* - **DOC/DOCX**
- **XLS/XLSX**
- **PPT/PPTX**
- **HWP/HWPX**
* - .. image:: images/icons/icon-docx.svg
:width: 40
:height: 40
- .. image:: images/icons/icon-xlsx.svg
:width: 40
:height: 40
- .. image:: images/icons/icon-pptx.svg
:width: 40
:height: 40
- .. image:: images/icons/icon-hangul.svg
:width: 40
:height: 40
Usage
--------------
Installation
~~~~~~~~~~~~~~~~~~
Install via pip with:
.. code-block:: bash
pip install pymupdfpro
Loading an **Office** document
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Import |PyMuPDF Pro| and you can then reference **Office** documents directly, e.g.:
.. code-block:: python
import pymupdf.pro
pymupdf.pro.unlock()
# PyMuPDF has now been extended with PyMuPDF Pro features, with some restrictions.
doc = pymupdf.open("my-office-doc.xls")
.. note::
All standard |PyMuPDF| functionality is exposed as expected - |PyMuPDF Pro| handles the extended **Office** file types
From then on you can work with document pages just as you would do normally, but with respect to the `restrictions <PyMuPDFPro_Restrictions>`.
Converting an **Office** document to **PDF**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following code snippet can convert your **Office** document to |PDF| format:
.. code-block:: python
import pymupdf.pro
pymupdf.pro.unlock()
doc = pymupdf.open("my-office-doc.xlsx")
pdfdata = doc.convert_to_pdf()
with open('output.pdf', 'wb') as f:
f.write(pdfdata)
.. _PyMuPDFPro_Restrictions:
Restrictions
~~~~~~~~~~~~~~~~~~~~
|PyMuPDF Pro| functionality is restricted without a license key as follows:
**Only the first 3 pages of any document will be available.**
To unlock full functionality you should `obtain a trial key <https://pymupdf.io/try-pro/>`_.
.. _PyMuPDFPro_TrialKeys:
Trial keys
-----------------------
To obtain a license key `please fill out the form on this page <https://pymupdf.io/try-pro/>`_. You will then have the trial key emailled to the address you submitted.
Using a key
~~~~~~~~~~~~~~~~
Initialize |PyMuPDF Pro| with a key as follows:
.. code-block:: python
import pymupdf.pro
pymupdf.pro.unlock(my_key)
# PyMuPDF has now been extended with PyMuPDF Pro features.
This will allow you to evaluate the product for a limited time. If you want to use |PyMuPDF Pro| after this time you should then `enquire about obtaining a commercial license <https://artifex.com/products/pymupdf-pro/>`_.
Fonts
-----------------------
By default `pymupdf.pro.unlock()` searches for all installed font directories.
This can be controlled with keyword-only args:
* `fontpath`: specific font directories, either as a list/tuple or `os.sep`-separated string.
If None (the default), we use `os.environ['PYMUPDFPRO_FONT_PATH']` if set.
* `fontpath_auto`: Whether to append system font directories.
If None (the default) we use true if `os.environ['PYMUPDFPRO_FONT_PATH_AUTO']` is '1'.
If true we append all system font directories.
Function `pymupdf.pro.get_fontpath()` returns a tuple of all font directories used by `unlock()`.
.. raw:: html
<button id="findOutAboutPyMuPDFPro" class="cta orange" onclick="window.location='https://pymupdf.io/try-pro/?utm_source=rtd-pymupdf&utm_medium=rtd&utm_content=cta-button'">Ready to try PyMuPDF Pro?</button>
.. include:: footer.rst
|
