Skip to content

Add Manifest.in and include license file in source distribution#71

Merged
ppannuto merged 1 commit into
ppannuto:mainfrom
synapticarbors:patch-1
Sep 4, 2020
Merged

Add Manifest.in and include license file in source distribution#71
ppannuto merged 1 commit into
ppannuto:mainfrom
synapticarbors:patch-1

Conversation

@synapticarbors
Copy link
Copy Markdown
Contributor

It would be helpful to include the license file in the source distribution

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 81.773% when pulling 6995ae0 on synapticarbors:patch-1 into ad696e6 on ppannuto:main.

@ppannuto
Copy link
Copy Markdown
Owner

ppannuto commented Sep 4, 2020

Is it really that necessary / useful to add a new file to the root with a single line in it?

Python has a standard for license management, it's the license key in setup.py, and MIT is a valid SPDX identifier. My instinct is that this is just bloat/cruft, but if there's a compelling reason to add it I suppose I don't really care that much either way.

@synapticarbors
Copy link
Copy Markdown
Contributor Author

It is indeed a single file with a single line, but it serves a functional purpose in that it tells the packaging process to include the license file in the source distribution so that it's in the tarball on pypi. Specifying the license in the setup.py as you mentioned only provides metadata about what the license is, but doesn't actually distribute the license. There are several ways to do this, but using a MANIFEST.in is the currently suggested way https://packaging.python.org/guides/using-manifest-in/#using-manifest-in. Other ways include adding a setup.cfg.

I submitted this PR since your package was recently packaged for conda-forge, and there we try to make sure that the license file is included in the source that we distribute to keep with the terms of the license. In the case of the MIT, it states:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

@ppannuto ppannuto merged commit dc81c6b into ppannuto:main Sep 4, 2020
ppannuto added a commit that referenced this pull request Jan 22, 2021
Major (interface) changes (#60) -- big thanks @iburago!!:
 - Read from an abbreviations file only when invoked from command line
 - Rename and refactor the create_wordlist_filter() function

Minor changes:
 - #63: Do not capitalize small words occurring within hyphenated word groups (thanks @iburago!)
 - #65: Always capitalize 'Mc'-prefixed small words in compound word groups (thanks @iburago!)
 - #67: Don't capitalize Mr, Ms, Mrs (thanks @GurraB!)
 - #71: Add Manifest.in and include license file in src dist (thanks @synapticarbors!)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants