Installing PyMuPDF-1.17 on Windows

[Horsmann]

Hi,
I am trying to build PyMuPDF in version 1.17 on Windows (I have a hard dependency on this version) but I don't get it installed.
I read the various older issues about building against mupdf-1.17 but I didn't find my issue among the reported problems.

When running python setup.py build in PyMuPDF I get:

Creating library build\temp.win-amd64-3.7\Release\fitz\_fitz.cp37-win_amd64.lib and object build\temp.win-amd64-3.7\Release\fitz\_fitz.cp37-win_amd64.exp
fitz_wrap.obj : error LNK2001: unresolved external symbol __security_check_cookie
fitz_wrap.obj : error LNK2001: unresolved external symbol fz_convert_pixmap
fitz_wrap.obj : error LNK2001: unresolved external symbol fz_write_pixmap_as_ps
fitz_wrap.obj : error LNK2001: unresolved external symbol fz_intersect_irect
fitz_wrap.obj : error LNK2001: unresolved external symbol fz_is_document_reflowable
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_annot_rect
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_unmark_obj
fitz_wrap.obj : error LNK2001: unresolved external symbol fz_run_page_contents
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_trailer
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_add_page
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_to_int
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_delete_annot
fitz_wrap.obj : error LNK2001: unresolved external symbol pdf_add_stream
.... endlessly long essentially every linking target is not found

Here is what I did so far which summarizes the details I found in the various location on the Internet:

• download mupdf-1.17
• copy _config.h into the fitz folder of mupdf-1.17 and replaced the config.h mupdf is shipping with
• Build mupdf in Visual Studio (Release version for win32 (x86) - succeeds without errors - this is the one I am using, x64 has some errors in the curl-library so I couldn't test it with x64)
• In PyMuPDF-1.17 setup.py set the installation paths for Windows to point to the include directory of mupdf
• In PyMuPDF-1.17 setup.py set the library directory to the Release output folder from building mupdf
• downloaded swigwin-4.0.2 and added it to my PATH

Is anything missing or did I overlook anything ? I don't figure out why I can't install this particular version.
Best,

[JorjMcKie]

You cannot use the PIP version 1.17?

I cannot tell the cause of the problem from my end. But I am generating all Windows wheels locally on my machines using VS Studio.
The MuPDF-compatible PyMuPDF source - with SWIG translation already applied - is also available on PIP, in the source download.
So you shouldn't have a problem using this together with a correctly built MuPDF 1.17 - either x86 or x64.

[Horsmann]

Hi,
when I just try to install it via pip I get this

i.e. pip install pymupdf==1.17.0

leads to an error which send me on the path of trying to compile it from source. It complains about a missing fitz.h header. I am using pymupdf also in an linux environment where the installation seems to work. Just on Windows it keeps failing with some missing C-headers.

  Using cached PyMuPDF-1.17.0-cp37-cp37m-win_amd64.whl (5.1 MB)
WARNING: Discarding https://files.pythonhosted.org/packages/29/82/496f2b97c03e1cde4caa1530225391aebb1aa24772aed1def628ba3234f5/PyMuPDF-1.17.0-cp37-cp37m-win_amd64.whl#sha256=eb9f47f2d4c7ad35412faedb59d2cbc7edb4589022f4000037641964d5b491b2 (from https://pypi.org/simple/pymupdf/). Requested pymupdf==1.17.0 from https://files.pythonhosted.org/packages/29/82/496f2b97c03e1cde4caa1530225391aebb1aa24772aed1def628ba3234f5/PyMuPDF-1.17.0-cp37-cp37m-win_amd64.whl#sha256=eb9f47f2d4c7ad35412faedb59d2cbc7edb4589022f4000037641964d5b491b2 has inconsistent version: filename has '1.17.0', but metadata has '1.16.18'
  Using cached PyMuPDF-1.17.0.tar.gz (197 kB)
Building wheels for collected packages: pymupdf
  Building wheel for pymupdf (setup.py) ... error
  ERROR: Command errored out with exit status 1:
   command: 'C:\Users\thorsmann\Anaconda3\envs\DSC\python.exe' -u -c 'import io, os, sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\THORSM~1\\AppData\\Local\\Temp\\pip-install-k_smudmy\\pymupdf_d77b68ce5254487eb36c44918ae95c80\\setup.py'"'"'; __file__='"'"'C:\\Users\\THORSM~1\\AppData\\Local\\Temp\\pip-install-k_smudmy\\pymupdf_d77b68ce5254487eb36c44918ae95c80\\setup.py'"'"';f = getattr(tokenize, '"'"'open'"'"', open)(__file__) if os.path.exists(__file__) else io.StringIO('"'"'from setuptools import setup; setup()'"'"');code = f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d 'C:\Users\THORSM~1\AppData\Local\Temp\pip-wheel-95m6bh5r'
       cwd: C:\Users\THORSM~1\AppData\Local\Temp\pip-install-k_smudmy\pymupdf_d77b68ce5254487eb36c44918ae95c80\
  Complete output (19 lines):
  running bdist_wheel
  running build
  running build_py
  creating build
  creating build\lib.win-amd64-3.7
  creating build\lib.win-amd64-3.7\fitz
  copying fitz\__init__.py -> build\lib.win-amd64-3.7\fitz
  copying fitz\fitz.py -> build\lib.win-amd64-3.7\fitz
  copying fitz\utils.py -> build\lib.win-amd64-3.7\fitz
  copying fitz\__main__.py -> build\lib.win-amd64-3.7\fitz
  running build_ext
  building 'fitz._fitz' extension
  creating build\temp.win-amd64-3.7
  creating build\temp.win-amd64-3.7\Release
  creating build\temp.win-amd64-3.7\Release\fitz
  C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.30.30705\bin\HostX86\x64\cl.exe /c /nologo /Ox /W3 /GL /DNDEBUG /MD -I./mupdf/include -I./mupdf/include/mupdf -IC:\Users\thorsmann\Anaconda3\envs\DSC\include -IC:\Users\thorsmann\Anaconda3\envs\DSC\include "-IC:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.30.30705\ATLMFC\include" "-IC:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.30.30705\include" "-IC:\Program Files (x86)\Windows Kits\NETFXSDK\4.8\include\um" "-IC:\Program Files (x86)\Windows Kits\10\include\10.0.22000.0\ucrt" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\shared" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\um" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\winrt" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\cppwinrt" /Tc./fitz/fitz_wrap.c /Fobuild\temp.win-amd64-3.7\Release\./fitz/fitz_wrap.obj
  fitz_wrap.c
  ./fitz/fitz_wrap.c(2733): fatal error C1083: Cannot open include file: 'fitz.h': No such file or directory
  error: command 'C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Tools\\MSVC\\14.30.30705\\bin\\HostX86\\x64\\cl.exe' failed with exit status 2
  ----------------------------------------
  ERROR: Failed building wheel for pymupdf
  Running setup.py clean for pymupdf
Failed to build pymupdf
Installing collected packages: pymupdf
    Running setup.py install for pymupdf ... error
    ERROR: Command errored out with exit status 1:
     command: 'C:\Users\thorsmann\Anaconda3\envs\DSC\python.exe' -u -c 'import io, os, sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\THORSM~1\\AppData\\Local\\Temp\\pip-install-k_smudmy\\pymupdf_d77b68ce5254487eb36c44918ae95c80\\setup.py'"'"'; __file__='"'"'C:\\Users\\THORSM~1\\AppData\\Local\\Temp\\pip-install-k_smudmy\\pymupdf_d77b68ce5254487eb36c44918ae95c80\\setup.py'"'"';f = getattr(tokenize, '"'"'open'"'"', open)(__file__) if os.path.exists(__file__) else io.StringIO('"'"'from setuptools import setup; setup()'"'"');code = f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record 'C:\Users\THORSM~1\AppData\Local\Temp\pip-record-bu4p7dv0\install-record.txt' --single-version-externally-managed --compile --install-headers 'C:\Users\thorsmann\Anaconda3\envs\DSC\Include\pymupdf'
         cwd: C:\Users\THORSM~1\AppData\Local\Temp\pip-install-k_smudmy\pymupdf_d77b68ce5254487eb36c44918ae95c80\
    Complete output (19 lines):
    running install
    running build
    running build_py
    creating build
    creating build\lib.win-amd64-3.7
    creating build\lib.win-amd64-3.7\fitz
    copying fitz\__init__.py -> build\lib.win-amd64-3.7\fitz
    copying fitz\fitz.py -> build\lib.win-amd64-3.7\fitz
    copying fitz\utils.py -> build\lib.win-amd64-3.7\fitz
    copying fitz\__main__.py -> build\lib.win-amd64-3.7\fitz
    running build_ext
    building 'fitz._fitz' extension
    creating build\temp.win-amd64-3.7
    creating build\temp.win-amd64-3.7\Release
    creating build\temp.win-amd64-3.7\Release\fitz
    C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.30.30705\bin\HostX86\x64\cl.exe /c /nologo /Ox /W3 /GL /DNDEBUG /MD -I./mupdf/include -I./mupdf/include/mupdf -IC:\Users\thorsmann\Anaconda3\envs\DSC\include -IC:\Users\thorsmann\Anaconda3\envs\DSC\include "-IC:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.30.30705\ATLMFC\include" "-IC:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.30.30705\include" "-IC:\Program Files (x86)\Windows Kits\NETFXSDK\4.8\include\um" "-IC:\Program Files (x86)\Windows Kits\10\include\10.0.22000.0\ucrt" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\shared" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\um" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\winrt" "-IC:\Program Files (x86)\Windows Kits\10\\include\10.0.22000.0\\cppwinrt" /Tc./fitz/fitz_wrap.c /Fobuild\temp.win-amd64-3.7\Release\./fitz/fitz_wrap.obj
    fitz_wrap.c
    ./fitz/fitz_wrap.c(2733): fatal error C1083: Cannot open include file: 'fitz.h': No such file or directory
    error: command 'C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Tools\\MSVC\\14.30.30705\\bin\\HostX86\\x64\\cl.exe' failed with exit status 2
    ----------------------------------------
ERROR: Command errored out with exit status 1: 'C:\Users\thorsmann\Anaconda3\envs\DSC\python.exe' -u -c 'import io, os, sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\THORSM~1\\AppData\\Local\\Temp\\pip-install-k_smudmy\\pymupdf_d77b68ce5254487eb36c44918ae95c80\\setup.py'"'"'; __file__='"'"'C:\\Users\\THORSM~1\\AppData\\Local\\Temp\\pip-install-k_smudmy\\pymupdf_d77b68ce5254487eb36c44918ae95c80\\setup.py'"'"';f = getattr(tokenize, '"'"'open'"'"', open)(__file__) if os.path.exists(__file__) else io.StringIO('"'"'from setuptools import setup; setup()'"'"');code = f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record 'C:\Users\THORSM~1\AppData\Local\Temp\pip-record-bu4p7dv0\install-record.txt' --single-version-externally-managed --compile --install-headers 

[JorjMcKie]

Obviously, this version happens to have no Windows wheels. Why don't you try the latest 1.17 version - 1.17.7?

[JorjMcKie]

You know you can inspect PIP releases and find one that contains a wheel for your configuration.

[Horsmann]

Why don't you try the latest 1.17 version - 1.17.7?
Absolutely valid point :) - I was too focused on getting 1.17.0 running that I didn't even looked for other minor version of 1.17. Thanks, this one is working!

[JorjMcKie]

Freue mich, dass es jetzt klappt!
Beste Grüße nach Deutschland.

[JorjMcKie]

Defining _fitz.sln etc. in VS is usually quite a hassle to get everything right. Maybe you have forgotten to correctly pointing to MuPDF libraries there - looks a bit like this.