diff --git a/docs/pymupdf-pro.rst b/docs/pymupdf-pro.rst deleted file mode 100644 index b032ea3ef..000000000 --- a/docs/pymupdf-pro.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. include:: header.rst - -.. include:: pymupdf-pro/pymupdf-pro.rst - -.. include:: footer.rst diff --git a/docs/pymupdf-pro/index.rst b/docs/pymupdf-pro/index.rst index d0c21903d..223e74755 100644 --- a/docs/pymupdf-pro/index.rst +++ b/docs/pymupdf-pro/index.rst @@ -1,6 +1,174 @@ .. include:: ../header.rst -.. include:: pymupdf-pro.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 `_. + + +.. 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 `, |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 `. + + +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 `_. + + +.. _PyMuPDFPro_TrialKeys: + +Trial keys +----------------------- + +To obtain a license key `please fill out the form on this page `_. 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 `_. + + +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 + + + + .. include:: ../footer.rst diff --git a/docs/pymupdf-pro/pymupdf-pro.rst b/docs/pymupdf-pro/pymupdf-pro.rst deleted file mode 100644 index 80d563d93..000000000 --- a/docs/pymupdf-pro/pymupdf-pro.rst +++ /dev/null @@ -1,169 +0,0 @@ - - -.. _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 `_. - - -.. 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 `, |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 `. - - -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 `_. - - -.. _PyMuPDFPro_TrialKeys: - -Trial keys ------------------------ - -To obtain a license key `please fill out the form on this page `_. 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 `_. - - -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 - - -