Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds PyMuPDF Pro page. #3684

Merged
merged 6 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/header.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@

<cite>PyMuPDF</cite>

.. |PyMuPDF Pro| raw:: html

<cite>PyMuPDF Pro</cite>

.. |PDF| raw:: html

<cite>PDF</cite>
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ This documentation covers all versions up to |version|.
:maxdepth: 1

about.rst
pymupdf-pro.rst


.. toctree::
Expand Down
107 changes: 107 additions & 0 deletions docs/pymupdf-pro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@

.. include:: header.rst



.. _pymupdf-pro

PyMuPDF Pro
=============


Enhance |PyMuPDF| capability with **Office** document support.

|PyMuPDF Pro| offers all the features of |PyMuPDF|, plus enhanced functionality to support **Office** documents.

- Load, parse and extract text data from **Office** files
- Able to render **Office** files


Office file support
----------------------

In addition to the `standard file types supported by PyMuPDF <Supported_File_Types>`, |PyMuPDF Pro| supports:

- DOC/DOCX
- PPT/PPTX
- XLS/XLXS
jamie-lemon marked this conversation as resolved.
Show resolved Hide resolved
- HWP/HWPX


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 pymupdfpro
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>`.


.. _PyMuPDFPro_Restrictions:

Restrictions
~~~~~~~~~~~~~~~~~~~~


|PyMuPDF Pro| functionality is restricted without a license key as follows:

**Only the first 10KB of any document will be available as extracted text.**
jamie-lemon marked this conversation as resolved.
Show resolved Hide resolved

To unlock full functionality you should `obtain a trial key <PyMuPDFPro_TrialKeys>`.


.. _PyMuPDFPro_TrialKeys:

Trial keys
-----------------------

To obtain a license key `please fill out the form on this page <https://artifex.com/products/pymupdf-pro/trial/>`_. 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 pymupdfpro
key = '...' # use key contents directly.
key = 'foo/my_pymupdfpro_key' # use key file.
pymupdf.init(key)

jamie-lemon marked this conversation as resolved.
Show resolved Hide resolved
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/>`_.


.. raw:: html

<button id="findOutAboutPyMuPDFPro" class="cta orange" onclick="window.location='https://artifex.com/products/pymupdf-pro?utm_source=rtd-pymupdf&utm_medium=rtd&utm_content=cta-button'">Ready to license PyMuPDF Pro?</button>





.. include:: footer.rst
10 changes: 10 additions & 0 deletions docs/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@
Resources
=============

**PyMuPDF Pro**
--------------------


For **Office** file support `try PyMuPDF Pro <pymupdf-pro>`.


|
----


Find out about **PyMuPDF Utilities**
-------------------------------------------------
Expand Down
Loading