PyMuPDF


NamePyMuPDF JSON
Version 1.24.13 PyPI version JSON
download
home_pageNone
SummaryA high performance Python library for data extraction, analysis, conversion & manipulation of PDF (and other) documents.
upload_time2024-10-29 15:44:46
maintainerNone
docs_urlNone
authorArtifex
requires_python>=3.9
licenseGNU AFFERO GPL 3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyMuPDF

**PyMuPDF** is a high performance **Python** library for data extraction, analysis, conversion & manipulation of [PDF (and other) documents](https://pymupdf.readthedocs.io/en/latest/the-basics.html#supported-file-types).

# Community
Join us on **Discord** here: [#pymupdf](https://discord.gg/TSpYGBW4eq)


# Installation

**PyMuPDF** requires **Python 3.9 or later**, install using **pip** with:

`pip install PyMuPDF`

There are **no mandatory** external dependencies. However, some [optional features](#pymupdf-optional-features) become available only if additional packages are installed.

You can also try without installing by visiting [PyMuPDF.io](https://pymupdf.io/#examples).


# Usage

Basic usage is as follows:

```python
import pymupdf # imports the pymupdf library
doc = pymupdf.open("example.pdf") # open a document
for page in doc: # iterate the document pages
  text = page.get_text() # get plain text encoded as UTF-8

```


# Documentation

Full documentation can be found on [pymupdf.readthedocs.io](https://pymupdf.readthedocs.io).



# <a id="pymupdf-optional-features"></a>Optional Features

* [fontTools](https://pypi.org/project/fonttools/) for creating font subsets.
* [pymupdf-fonts](https://pypi.org/project/pymupdf-fonts/) contains some nice fonts for your text output.
* [Tesseract-OCR](https://github.com/tesseract-ocr/tesseract) for optical character recognition in images and document pages.



# About

**PyMuPDF** adds **Python** bindings and abstractions to [MuPDF](https://mupdf.com/), a lightweight **PDF**, **XPS**, and **eBook** viewer, renderer, and toolkit. Both **PyMuPDF** and **MuPDF** are maintained and developed by [Artifex Software, Inc](https://artifex.com).

**PyMuPDF** was originally written by [Jorj X. McKie](mailto:jorj.x.mckie@outlook.de).


# License and Copyright

**PyMuPDF** is available under [open-source AGPL](https://www.gnu.org/licenses/agpl-3.0.html) and commercial license agreements. If you determine you cannot meet the requirements of the **AGPL**, please contact [Artifex](https://artifex.com/contact/pymupdf-inquiry.php) for more information regarding a commercial license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "PyMuPDF",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Artifex",
    "author_email": "support@artifex.com",
    "download_url": "https://files.pythonhosted.org/packages/22/39/84efca63af4e5a014c1d4c21686469f99c3d1c160a3a0b902ac676f6ffd9/PyMuPDF-1.24.13.tar.gz",
    "platform": null,
    "description": "# PyMuPDF\n\n**PyMuPDF** is a high performance **Python** library for data extraction, analysis, conversion & manipulation of [PDF (and other) documents](https://pymupdf.readthedocs.io/en/latest/the-basics.html#supported-file-types).\n\n# Community\nJoin us on **Discord** here: [#pymupdf](https://discord.gg/TSpYGBW4eq)\n\n\n# Installation\n\n**PyMuPDF** requires **Python 3.9 or later**, install using **pip** with:\n\n`pip install PyMuPDF`\n\nThere are **no mandatory** external dependencies. However, some [optional features](#pymupdf-optional-features) become available only if additional packages are installed.\n\nYou can also try without installing by visiting [PyMuPDF.io](https://pymupdf.io/#examples).\n\n\n# Usage\n\nBasic usage is as follows:\n\n```python\nimport pymupdf # imports the pymupdf library\ndoc = pymupdf.open(\"example.pdf\") # open a document\nfor page in doc: # iterate the document pages\n  text = page.get_text() # get plain text encoded as UTF-8\n\n```\n\n\n# Documentation\n\nFull documentation can be found on [pymupdf.readthedocs.io](https://pymupdf.readthedocs.io).\n\n\n\n# <a id=\"pymupdf-optional-features\"></a>Optional Features\n\n* [fontTools](https://pypi.org/project/fonttools/) for creating font subsets.\n* [pymupdf-fonts](https://pypi.org/project/pymupdf-fonts/) contains some nice fonts for your text output.\n* [Tesseract-OCR](https://github.com/tesseract-ocr/tesseract) for optical character recognition in images and document pages.\n\n\n\n# About\n\n**PyMuPDF** adds **Python** bindings and abstractions to [MuPDF](https://mupdf.com/), a lightweight **PDF**, **XPS**, and **eBook** viewer, renderer, and toolkit. Both **PyMuPDF** and **MuPDF** are maintained and developed by [Artifex Software, Inc](https://artifex.com).\n\n**PyMuPDF** was originally written by [Jorj X. McKie](mailto:jorj.x.mckie@outlook.de).\n\n\n# License and Copyright\n\n**PyMuPDF** is available under [open-source AGPL](https://www.gnu.org/licenses/agpl-3.0.html) and commercial license agreements. If you determine you cannot meet the requirements of the **AGPL**, please contact [Artifex](https://artifex.com/contact/pymupdf-inquiry.php) for more information regarding a commercial license.\n",
    "bugtrack_url": null,
    "license": "GNU AFFERO GPL 3.0",
    "summary": "A high performance Python library for data extraction, analysis, conversion & manipulation of PDF (and other) documents.",
    "version": "1.24.13",
    "project_urls": {
        "Changelog": "https://pymupdf.readthedocs.io/en/latest/changes.html",
        "Documentation": "https://pymupdf.readthedocs.io/",
        "Source": "https://github.com/pymupdf/pymupdf",
        "Tracker": "https://github.com/pymupdf/PyMuPDF/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce798d31a98ebeb329000406d6c36fb2ad42264d5a4a6915ebabbde332642204",
                "md5": "a19f0db90c628c425ca39c49c3ee3e23",
                "sha256": "c11bb9198af69d490b4b346421db827d875a28fbc760d239e691d4b3ed12b5ad"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13-cp39-abi3-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "a19f0db90c628c425ca39c49c3ee3e23",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 19147116,
            "upload_time": "2024-10-29T15:41:19",
            "upload_time_iso_8601": "2024-10-29T15:41:19.139728Z",
            "url": "https://files.pythonhosted.org/packages/ce/79/8d31a98ebeb329000406d6c36fb2ad42264d5a4a6915ebabbde332642204/PyMuPDF-1.24.13-cp39-abi3-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eafeff2bb633c0934ba43c36184b8ed025092e946994dc6b4c764a0079f0ab3c",
                "md5": "9836c6f11186a35d458434e0cb417752",
                "sha256": "240d5c43daa9278db50d609162b48f673ab256d7e5c73eea67af517c1fc2d47c"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13-cp39-abi3-macosx_11_0_arm64.whl",
            "has_sig": false,
            "md5_digest": "9836c6f11186a35d458434e0cb417752",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 18406545,
            "upload_time": "2024-10-29T15:41:40",
            "upload_time_iso_8601": "2024-10-29T15:41:40.072301Z",
            "url": "https://files.pythonhosted.org/packages/ea/fe/ff2bb633c0934ba43c36184b8ed025092e946994dc6b4c764a0079f0ab3c/PyMuPDF-1.24.13-cp39-abi3-macosx_11_0_arm64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8548e4630eb58f4daed22a078e19db8a709d407d2e19316089675f6ed185f01a",
                "md5": "5aeec8625b4e15e63d00d52be5bcbdb5",
                "sha256": "c830610e4fde237fcf0532f1f8c1381453f48c164a5eadd0c6e5fd0bea1ca8e3"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "5aeec8625b4e15e63d00d52be5bcbdb5",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 19812221,
            "upload_time": "2024-10-29T15:42:35",
            "upload_time_iso_8601": "2024-10-29T15:42:35.436430Z",
            "url": "https://files.pythonhosted.org/packages/85/48/e4630eb58f4daed22a078e19db8a709d407d2e19316089675f6ed185f01a/PyMuPDF-1.24.13-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d225aa9e01747518878a54866b4d925abdc663c64c75f5fbc6a9706957a7a30",
                "md5": "21d950e7a3899f5fc1d04ace42969442",
                "sha256": "4520558580ac6b5a7164fda29fbc14e39d3114fd803420721500edbf47d04872"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13-cp39-abi3-musllinux_1_2_x86_64.whl",
            "has_sig": false,
            "md5_digest": "21d950e7a3899f5fc1d04ace42969442",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 20942140,
            "upload_time": "2024-10-29T15:42:09",
            "upload_time_iso_8601": "2024-10-29T15:42:09.269096Z",
            "url": "https://files.pythonhosted.org/packages/6d/22/5aa9e01747518878a54866b4d925abdc663c64c75f5fbc6a9706957a7a30/PyMuPDF-1.24.13-cp39-abi3-musllinux_1_2_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "07a42e545217436e7717642809c7392bd7d7156ba102e7a47acb22659bfd41de",
                "md5": "cd0adf41fc441fc31f91d27a83622917",
                "sha256": "ab22828d4fc205791ef1332a64893cbfc38cd9c331c5f46ae4537372ffee6fc1"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13-cp39-abi3-win32.whl",
            "has_sig": false,
            "md5_digest": "cd0adf41fc441fc31f91d27a83622917",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 14943060,
            "upload_time": "2024-10-29T15:43:05",
            "upload_time_iso_8601": "2024-10-29T15:43:05.966470Z",
            "url": "https://files.pythonhosted.org/packages/07/a4/2e545217436e7717642809c7392bd7d7156ba102e7a47acb22659bfd41de/PyMuPDF-1.24.13-cp39-abi3-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3880f8d8ae555b237574005faef8a181a5c6a1d983e16a982b65ccc56a42faa2",
                "md5": "a3539e160fe804a10e05f9d85d8ec005",
                "sha256": "ec17914e4a560f4070212a2e84db5cc8b561d85d1ead193605a22f9561b03148"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13-cp39-abi3-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "a3539e160fe804a10e05f9d85d8ec005",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 16242035,
            "upload_time": "2024-10-29T15:42:52",
            "upload_time_iso_8601": "2024-10-29T15:42:52.172506Z",
            "url": "https://files.pythonhosted.org/packages/38/80/f8d8ae555b237574005faef8a181a5c6a1d983e16a982b65ccc56a42faa2/PyMuPDF-1.24.13-cp39-abi3-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "223984efca63af4e5a014c1d4c21686469f99c3d1c160a3a0b902ac676f6ffd9",
                "md5": "557486428e5411a3ba497186153b2c5c",
                "sha256": "6ec3ab3c6d5cba60bfcf58daaa2d1a5b700b0366ce52be666445007351461fa4"
            },
            "downloads": -1,
            "filename": "PyMuPDF-1.24.13.tar.gz",
            "has_sig": false,
            "md5_digest": "557486428e5411a3ba497186153b2c5c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 53655596,
            "upload_time": "2024-10-29T15:44:46",
            "upload_time_iso_8601": "2024-10-29T15:44:46.765159Z",
            "url": "https://files.pythonhosted.org/packages/22/39/84efca63af4e5a014c1d4c21686469f99c3d1c160a3a0b902ac676f6ffd9/PyMuPDF-1.24.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-29 15:44:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pymupdf",
    "github_project": "pymupdf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pymupdf"
}
        
Elapsed time: 0.40846s