README.md installed to /usr/README.md

[swt2c]

Hi,

When installing 1.18.10 on Fedora, README.md gets installed to /usr/README.md. Also, there's this warning from setup.py:

running install_data
warning: install_data: setup script did not provide a directory for 'README.md' -- installing right in '/builddir/build/BUILDROOT/python-PyMuPDF-1.18.10-1.fc35.x86_64/usr'
copying README.md -> /builddir/build/BUILDROOT/python-PyMuPDF-1.18.10-1.fc35.x86_64/usr

This doesn't seem like the correct location to install the README.

[JorjMcKie]

I started including files README.md and changes.rst in the source distribution based on request in #888.
Would you please coordinate with the issuer of #888, @jayvdb, what I should include and where?
I have no problem making any adjustments - as long as there is no moving target ...

[jayvdb]

On openSUSE, I just delete the installed doc files as they will be handled by %doc in rpmbuild. So it doesnt matter to me where, or even if, they are installed. I only need them to be in the sdist tarball.

[JorjMcKie]

@jayvdb - thanks for that prompt reaction ...
@swt2c - what do you say?

[swt2c]

I agree, I think we want the README.md to be in the source distribution. I would suggest not installing it by default though. Probably removing it from data_files in setup.py would be sufficient?

[JorjMcKie]

removing it from data_files in setup.py would be sufficient?

Let me check whether setup.py sdist will let it survive ...

No: commenting out the `data files or some of its items will lead to those items being dropped from the tarball altogether. So, what should I do?

[swt2c]

I believe the recommended way for controlling what goes in sdist is to use MANIFEST.in:
https://packaging.python.org/guides/using-manifest-in/

[JorjMcKie]

@swt2c - thank you.
Ok, I created MANIFEST.in with the following contents:

include fitz/_config.h
include changes.rst
include README.md
include PKG-INFO
include COPYING

Also modified setup.py to use setuptools instead of the outdated distutils.
Now, setup.py no longer contains a data_files argument.
The presence of README.md also no longer leads to an admonition when running python setup.py sdist.
A PyMuPDF.egg-info folder is created additionally.

After all this, the .tar.gz file has the following layout:

PyMuPDF-1.18.11.tar.gz
    PyMuPDF-1.18.11.tar
        .
        PyMuPDF-1.18.11
            fitz
                fitz.py
                fitz_wrap.c
                utils.py
                _config.h
                __init__.py
                __main__.py
            PyMuPDF.egg-info
                dependency_links.txt
                PKG-INFO
                SOURCES.txt
                top_level.txt
            changes.rst
            COPYING
            MANIFEST.in
            PKG-INFO
            README.md
            setup.cfg
            setup.py

[JorjMcKie]

@jayvdb / @swt2c - please confirm you are fine with this.

[swt2c]

Looks good to me.

[JorjMcKie]

Resolved by v1.18.11 just uploaded.

[swt2c]

It seems that README.md is still in data_files, though:
https://github.com/pymupdf/PyMuPDF/blob/master/setup.py#L159

Also, I don't see the MANIFEST.in in git?

[JorjMcKie]

@swt2c - thanks, will be corrected next version.

[swt2c]

README.md is still included in data_files...

[JorjMcKie]

@swt2c - I have completely reworked the setup:

• There no longer are separate long descriptions in files PKG-INFO and README.md. The long description is now identical to the content of README.md.
• File PKG-INFO has gone completely. The setup generates this file internally from other information.
• setup.py now uses setuptools and no longer distutils.
• There is a new option to ease specifying MuPDF library locations: setup.py checks the presence of os.environ["PYMUPDF-DIRS"]. If found it assumes the value to be a filename containing JSON syntax like this:

{ "include_dirs": ["filename1", "filename2"], "library_dirs": ["filename3", "filename4"]}

The encountered lists are then appended to the predefined ones in setup.
Hopefully this obsoletes the need to manually modify setup.py.