Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: explicitly declare license with classifier #2281

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

WilliamRoyNelson
Copy link
Contributor

Description

Adds PyPI project classifiers to explicitly declare the software license.
Classifiers are used to add information to the classifiers panel in PyPI. Example from NumPy:
image

Motivation and Context

The reason that it is very important for this information to be present is that in an enterprise environment, security tools like Sonatype Nexus IQ are used to manage open source software risk. Nexus IQ specifically can be configured to classify packages according to their license. This prevents developers from inadvertently using licenses like GNU General Public License v2.0 without realizing that they may be legally obligated to make their entire project open source.

Because these libraries do not declare their license via classifiers, automated tools cannot properly determine the license and may treat them as high-risk packages.
image

How Has This Been Tested?

I have made nearly identical changes to other Open Source projects:
Examples:
trubrics/streamlit-feedback#12
bashtage/linearmodels#545
matthewwardrop/formulaic#144

CheckList

  • PR title addresses the issue accurately and concisely
  • Updates Documentation and Docstrings
  • Adds tests
  • Adds instrumentation (logs, or UI events)

@boring-cyborg boring-cyborg bot added area:common From common folder area:databuilder From databuilder folder area:frontend From the Frontend folder area:metadata From the metadata folder area:search From the search folder labels Dec 13, 2024
Copy link

boring-cyborg bot commented Dec 13, 2024

Congratulations on your first Pull Request and welcome to Amundsen community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/amundsen-io/amundsen/blob/main/CONTRIBUTING.md)

@kristenarmes
Copy link
Contributor

thanks for the PR @WilliamRoyNelson! can you follow the steps here to rebase the branch to include a sign off on your commit, and then it should be good to merge

@WilliamRoyNelson
Copy link
Contributor Author

thanks for the PR @WilliamRoyNelson! can you follow the steps here to rebase the branch to include a sign off on your commit, and then it should be good to merge

It looks like the DCO check now passes. I think I did it correctly. I've never used this Git feature before, thank you for pointing it out to me!

@kristenarmes kristenarmes merged commit f9a835b into amundsen-io:main Dec 13, 2024
22 checks passed
Copy link

boring-cyborg bot commented Dec 13, 2024

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:common From common folder area:databuilder From databuilder folder area:frontend From the Frontend folder area:metadata From the metadata folder area:search From the search folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants