On 12/4/21 1:42 pm, John Rouillard wrote:
> 
> John Rouillard added the comment:
> 
> Hi John:
> 
> In message <4d988495-a405-0242-af46-64e263b858ad@jerrykan.com>,
> John Kristensen writes:
>> Looks like I missed that reference to the MANIFEST file, so yes your
>> suggested change would seem to be correct and needs to be included in
>> the patch.
> 
> Wilco.

I've updated the RELEASE.txt files to correctly refer to 
`roundup.egg-info/SOURCES.txt` in all places where `MANIFEST` was 
previously reference.

> 
>>> Also is looks like MANIFEST.in is still
>>> valid for setuptools. I assume the reference for changing
>>> MANIFEST.in should change from:
>>>
>>>     http://docs.python.org/2/distutils/sourcedist.html#manifest-template
>>>
>>> to:
>>>
>>>     https://packaging.python.org/guides/using-manifest-in/#using-manifest-
>>> in
>>>
>>> correct?
>>
>> It seems the Python2 documentation is the only place that documents what
>> should go in the MANIFEST.in file.
>>
>> The packaging.python.org links seems to be a dead link (even though it
>> is referenced in other parts of the documentation).
> 
> Eep. I just got the link from the docs, never actually tried it 8-/.

The packaging.python.org link has now been fixed, so I've also updated 
the RELEASE.txt to use this link. Though at some point we may want to 
move away from using the MANIFEST.in file (see below)

> 
>> [...]
>> However it seems that setuptools does provide alternative methods to
>> using MANIFEST.in, see:
>>
>>      https://setuptools.readthedocs.io/en/latest/userguide/datafiles.html
>>
>> My reading of that seem to indicate that we should be using
>> `include_package_data=True` so that backwards compatibility with
>> MANIFEST.in is kept even if we don't use that alternative options.
> 
> So add `include_package_data=True` at the end of the setup call after:
> 
>   data_files=data_files
> 
> Correct?

I tried running `python setup.py sdist` with and without this line added 
and it made no difference to the generated 
`roundup.egg-info/SOURCES.txt` file. So it seems the MANIFEST.in file is 
used even without this option. I also had a closer look at the 
documentation and noticed this comment:

 > If using the setuptools-specific include_package_data argument, files
 > specified by package_data will not be automatically added to the
 > manifest unless they are listed in the MANIFEST.in file.

My reading of this seems to indicate that by continuing to use 
MANIFEST.in we may end up having to maintaining the list of data files 
in multiple places. It may be better to move away from using the 
MANIFEST.in file to managing these data files in the setup.py file.

For the time being I've not included the `include_package_data=True` option.

The update commits can be found at 
https://github.com/roundup-tracker/roundup/compare/master...jerrykan:setuptools