PyMuPDF


NamePyMuPDF JSON
Version 1.25.1 PyPI version JSON
download
home_pageNone
SummaryA high performance Python library for data extraction, analysis, conversion & manipulation of PDF (and other) documents.
upload_time2024-12-11 22:48:29
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/c3/88/76c076c152be6d29a792defc3b3bff73de7f690e55f978b66adf6dbb8a1a/pymupdf-1.25.1.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.25.1",
    "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": "927be7205ea48f547122c226a34f5452bc72915b6d06d7925970b8dd3493baf1",
                "md5": "455c06618762f1378950177a4f8a7671",
                "sha256": "793f9f6d51029e97851c711b3f6d9fe912313d95a306fbe8b1866f301d0e2bd3"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1-cp39-abi3-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "455c06618762f1378950177a4f8a7671",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 19364135,
            "upload_time": "2024-12-11T22:46:33",
            "upload_time_iso_8601": "2024-12-11T22:46:33.930015Z",
            "url": "https://files.pythonhosted.org/packages/92/7b/e7205ea48f547122c226a34f5452bc72915b6d06d7925970b8dd3493baf1/pymupdf-1.25.1-cp39-abi3-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0eb62ad245dcbbb1abae9eeb8de5049b27c12c9ee8590c6c769499e386164bd6",
                "md5": "8eba43408a26fe0ecbaec826863e26e5",
                "sha256": "15e6f4013ad0a029a2221920f9d2081f56dc43259dabfdf5cad7fbf1cee4b5a7"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1-cp39-abi3-macosx_11_0_arm64.whl",
            "has_sig": false,
            "md5_digest": "8eba43408a26fe0ecbaec826863e26e5",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 18598176,
            "upload_time": "2024-12-11T22:46:51",
            "upload_time_iso_8601": "2024-12-11T22:46:51.853796Z",
            "url": "https://files.pythonhosted.org/packages/0e/b6/2ad245dcbbb1abae9eeb8de5049b27c12c9ee8590c6c769499e386164bd6/pymupdf-1.25.1-cp39-abi3-macosx_11_0_arm64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77157bf672afb99002ad813aeb4886cc601bb9a4629210d9a3906a8d5650a941",
                "md5": "8456ab017260e29be694b581549a0780",
                "sha256": "b63f8e9e65b0bda48f9217efd4d2a8c6d7a739dd28baf460c1ae78439b9af489"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "8456ab017260e29be694b581549a0780",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 20021618,
            "upload_time": "2024-12-11T22:47:04",
            "upload_time_iso_8601": "2024-12-11T22:47:04.314685Z",
            "url": "https://files.pythonhosted.org/packages/77/15/7bf672afb99002ad813aeb4886cc601bb9a4629210d9a3906a8d5650a941/pymupdf-1.25.1-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8ce31a7a8400f1688c3c782478635ca929f85facd266157e4b90d650766bc49d",
                "md5": "4e55d10d1c43441143adddeb1765dfa1",
                "sha256": "a687bd387589e30abd810a78a23341f57f43fa16a4d8d8c0b870bb6d89607343"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1-cp39-abi3-musllinux_1_2_x86_64.whl",
            "has_sig": false,
            "md5_digest": "4e55d10d1c43441143adddeb1765dfa1",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 21144453,
            "upload_time": "2024-12-11T22:46:02",
            "upload_time_iso_8601": "2024-12-11T22:46:02.351749Z",
            "url": "https://files.pythonhosted.org/packages/8c/e3/1a7a8400f1688c3c782478635ca929f85facd266157e4b90d650766bc49d/pymupdf-1.25.1-cp39-abi3-musllinux_1_2_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1d1440b267842a1374f8d55c508302882f2ef7dd0f859514f060e1618ef97aa",
                "md5": "247c7d1ff8dd9faff77831807bf5d2f2",
                "sha256": "fc7dbc1aa9e298a4c81084e389c9623c26fcaa232c71efaa073af150069e2221"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1-cp39-abi3-win32.whl",
            "has_sig": false,
            "md5_digest": "247c7d1ff8dd9faff77831807bf5d2f2",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 15112052,
            "upload_time": "2024-12-11T22:47:35",
            "upload_time_iso_8601": "2024-12-11T22:47:35.641783Z",
            "url": "https://files.pythonhosted.org/packages/a1/d1/440b267842a1374f8d55c508302882f2ef7dd0f859514f060e1618ef97aa/pymupdf-1.25.1-cp39-abi3-win32.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "46728c5bbf817aacebe21a454f3ade8ee4b5b17afe698bb73d65c4ca23a89a87",
                "md5": "3e87531aaa0dc69b057f2cadc7aee1f4",
                "sha256": "e2b0b73c0aab0f863e5132c93cfa4607e8129feb1afa3d544b2cf7f172c50b5a"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1-cp39-abi3-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "3e87531aaa0dc69b057f2cadc7aee1f4",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 16559080,
            "upload_time": "2024-12-11T22:47:20",
            "upload_time_iso_8601": "2024-12-11T22:47:20.112577Z",
            "url": "https://files.pythonhosted.org/packages/46/72/8c5bbf817aacebe21a454f3ade8ee4b5b17afe698bb73d65c4ca23a89a87/pymupdf-1.25.1-cp39-abi3-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c38876c076c152be6d29a792defc3b3bff73de7f690e55f978b66adf6dbb8a1a",
                "md5": "615135b1c130d0a9b988ad2d2122b135",
                "sha256": "6725bec0f37c2380d926f792c262693c926af7cc1aa5aa2b8207e771867f015a"
            },
            "downloads": -1,
            "filename": "pymupdf-1.25.1.tar.gz",
            "has_sig": false,
            "md5_digest": "615135b1c130d0a9b988ad2d2122b135",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 60979390,
            "upload_time": "2024-12-11T22:48:29",
            "upload_time_iso_8601": "2024-12-11T22:48:29.134172Z",
            "url": "https://files.pythonhosted.org/packages/c3/88/76c076c152be6d29a792defc3b3bff73de7f690e55f978b66adf6dbb8a1a/pymupdf-1.25.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-11 22:48:29",
    "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.40091s