Skip to content

Add dependency license report script #568

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

Merged

Conversation

jusdino
Copy link
Collaborator

@jusdino jusdino commented Feb 19, 2025

Description List

  • Add a script at a root bin folder to look for NodeJS and Python dependencies, then report on their licenses

Testing List

  • Run it!

Closes #564

Copy link
Collaborator

@landonshumway-ia landonshumway-ia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good start, but I notice a handful of rows in the csv file have UNKNOWN or NOASSERTION for the license even though that information is available through GH and Pypi, for example the publication python module is using the MIT license, but the script was unable to find it.

publication GH: https://github.com/glyph/publication?tab=MIT-1-ov-file
publication Pypi: https://pypi.org/project/publication/

cachecontrol (licensed under apache 2.0)
GH: https://github.com/psf/cachecontrol?tab=License-1-ov-file
Pypi: https://pypi.org/project/CacheControl/

Obviously, the script likely won't be able to find every single license, but if the intent is to have a human fill in the gaps, then we should check in the latest csv file with all the unknowns filled in so that the next time we need to run this, the human developer doesn't have to dig so much for all the unknown licenses.

Copy link
Collaborator

@landonshumway-ia landonshumway-ia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! This script will come in handy as the project grows

@jusdino jusdino requested a review from jlkravitz February 19, 2025 18:15
Copy link
Collaborator

@jlkravitz jlkravitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I don't have much context on the use-case here (though I think it is a good thing to do), so not sure how accurate this needs to be. My two comments only really matter if accuracy is key (e.g., for legal compliance).

Copy link
Collaborator

@jlkravitz jlkravitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@isabeleliassen Good to go.

@isabeleliassen isabeleliassen self-requested a review February 24, 2025 22:13
@isabeleliassen isabeleliassen merged commit 092b166 into csg-org:development Feb 24, 2025
@jusdino jusdino deleted the feat/dependency-report-script branch February 28, 2025 02:46
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.

compile license information
4 participants