Setuptools will install licenses if included in setup.cfg

[dtaneli]

python setup.py sdist now includes the license file if license_file
is included in setup.cfg unless it is explicitly excluded in MANIFEST.in.

Co-Authored-By: Poyzan Nur Taneli [email protected]

Summary of changes

Closes #357

Pull Request Checklist

• Changes have tests
• News fragment added in changelog.d. See documentation for details

[pganssle]

@dtaneli Can you add some tests for this?

[dtaneli]

Hi @pganssle, I added some tests but I am not sure if it is better to merge these four test cases into a single test or not. Any preferences?

Also, does this change warrant a changelog update?

[pganssle]

@dtaneli It is generally preferable to have separate tests, or parametrized tests, but I think in the spirit of DRY (don't repeat yourself), it might be better to refactor these a single parametrized test.

[pganssle]

And yes, this is a behavior change, it definitely needs a changelog.

[dtaneli]

Made the tests parametrized, added a changelog entry and updated thesetup.cfg documentation.

@pganssle, during the London sprint, we discussed re-using license = file:<path> instead of license_file = <path> since the usage of these attributes kind of overlap. Or maybe we would like to support both?

[pganssle]

@dtaneli The license field is something completely different, it's used for the name of the license. You'd put something like Apache 2.0 in that field, not the text of the license, or the license file.

[dtaneli]

Ok, I just wanted to make sure because we found that you could actually pass a file according to https://setuptools.readthedocs.io/en/latest/setuptools.html#metadata

---

Is there anything else that is missing for the scope of this issue?

[jakirkham]

Thanks for doing this @dtaneli and @jaraco for reviewing!