Fix license metadata for compliance tools like GitHub Licensed#65
Open
devclinton wants to merge 1 commit intoanderskm:masterfrom
Open
Fix license metadata for compliance tools like GitHub Licensed#65devclinton wants to merge 1 commit intoanderskm:masterfrom
devclinton wants to merge 1 commit intoanderskm:masterfrom
Conversation
Switch from distutils to setuptools and add license classifier so that license-compliance tools (e.g. GitHub Licensed) can detect the MIT license from installed package metadata (.dist-info/METADATA). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Owner
|
I have verified the content of |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
distutils.coretosetuptools—distutilsdoes not generate.dist-info/METADATAwhen a package is installed via pip, which is the primary mechanism that license-compliance tools use to discover package license information.license_files = ['LICENSE.txt']— explicitly includes the license file in the built distribution metadata, ensuring it is present in.dist-info/.License :: OSI Approved :: MIT Licenseclassifier — provides a standardized, machine-readable license identifier that tools like GitHub Licensed use as a fallback when scanning dependencies.Motivation
When GPUtil is installed as a dependency in another project and that project runs GitHub Licensed to audit/cache dependency licenses, Licensed fails to detect GPUtil's MIT license. This is because
distutils-based installs don't produce the.dist-info/METADATAfile that Licensed (and pip itself) rely on for license discovery. These changes are the minimal set needed to make the license correctly discoverable by automated compliance tooling.Test plan
pip install .and verify.dist-info/METADATAcontainsLicense: MITandClassifier: License :: OSI Approved :: MIT Licenselicensed cache/licensed statusin a consuming project and confirm GPUtil's license is detected