nexB / scancode-toolkit

:mag: ScanCode detects licenses, copyrights, dependencies by "scanning code" ... to discover and inventory open source and third-party packages used in your code. Sponsored by NLnet project https://nlnet.nl/project/vulnerabilitydatabase, the Google Summer of Code, Azure credits, nexB and others generous sponsors!
https://github.com/nexB/scancode-toolkit/releases/
2.02k stars 533 forks source link

Add extra documentation to each package class #3799

Open pombredanne opened 3 weeks ago

pombredanne commented 3 weeks ago

We should add extra documentation to each package class, possibly structured as attributes in order to better capture the breadth and depth of the data we collect to generate a summary table for all the things we have. This could include new things:

Beyond mere documentation, some of these attributes may have a practical use (like the command for dependency-inspector)

We should also track the relationship to other data files and manifests (important so we cant start treating these as pairs or groups). This could be an attribute, or a new class of its own that groups many datafile handler classes.