Skip to content

Commit d49f75a

Browse files
committed
Mention SWIG requirement
1 parent 5f9bf8e commit d49f75a

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ The platform tag for Mac OSX is `macosx_10_6_intel`.
3030

3131
The platform tag for Linux is `manylinux1_x86_64`, which makes these wheels usable on Debian, Ubuntu and most other variations.
3232

33-
On other operating systems you need to generate PyMuPDF yourself. And of course you can choose to do so for a wheel-supported platform, too. Before you can do this, you must download and generate MuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures for achieving this. Please observe the following general steps:
33+
On other operating systems you need to generate PyMuPDF yourself. And of course you can choose to do so for a wheel-supported platform, too.
34+
35+
To do this, you must download and generate MuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures for achieving this. Please observe the following general steps:
3436

3537
* Be sure to download the official MuPDF source release from [here](https://mupdf.com/downloads/archive). Do **not use** MuPDF's [GitHub repo](https://github.com/ArtifexSoftware/mupdf). It contains their current **development source**, which is **not compatible** with this PyMuPDF version most of the time.
3638

@@ -40,6 +42,11 @@ On other operating systems you need to generate PyMuPDF yourself. And of course
4042
- PDF device module `_pdf-device.c` copy-replace to: `mupdf/source/pdf/pdf-device.c`. It fixes a bug which caused method `Document.convertToPDF()` to bring down the interpeter.
4143
- Now MuPDF can be generated.
4244

45+
* Since PyMuPDF v1.14.17, the sources provided in this repository **no longer contain** the interface files ``fitz.py`` and ``fitz.wrap.c`` - they are generated **"on the fly"** by ``setup.py`` using the interface generator [SWIG](http://www.swig.org/). So you need SWIG being installed on your system. Please refer to issue #312 for a background.
46+
47+
* If you do **not (want to) use SWIG** for generating PyMuPDF, please download the **sources from PyPI** - they continue to contain the interface files.
48+
- Side note: those files have been generated using **SWIG v4.0.0**, which implements important improvements regarding security and also generates a much simpler ``fitz.py``. Our wheels are based on this SWIG version, too.
49+
4350
Once this is done, adjust directories in ``setup.py`` and run ``python setup.py install``.
4451

4552
The following sections contain further comments for some platforms.

doc/PyMuPDF.pdf

5.15 KB
Binary file not shown.

doc/html.zip

653 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)