citation-file-format / cffconvert

Command line program to validate and convert CITATION.cff files.
Apache License 2.0
100 stars 28 forks source link

[Contribution Request] Add License to `setup.cfg` #289

Closed kevinmatthes closed 1 year ago

kevinmatthes commented 2 years ago

According to the contribution guidelines for contributions of type three (changes to the code base), I would like to discuss an enhancement I would like to introduce as a Pull Request.

Many Python 3 projects name their licenses in their setup.cfgs, see the references for examples. This project does not have such an entry in its setup.cfg. I would like to add it in a new Pull Request.

In addition, I would like to mention that there is a free and open source Python 3-CLI licensed MIT which would not only do this itself but would also automatically maintain the setup.cfg: setup-cfg-fmt, see the references. Running it over the setup.cfg would change more than only adding the version automatically, however, for instance, it would remove all comments. I mention it here just for completeness.

References

jspaaks commented 1 year ago

Thanks @kevinmatthes for this suggestion. I'd welcome a PR that adds the license and license_file keys in setup.cfg's [metadata], but I'd like to opt out of having more tools to help maintain setup.cfg for the moment.

jspaaks commented 1 year ago

Quick update on this, I am in the process of moving to a pyproject.toml based configuration, and as part of that I have included the license information both as a dedicated license key and as a classifier.

Refs:

jspaaks commented 1 year ago

Issues was fixed in PR #313, closing this issue