@@ -11,7 +11,7 @@ Compute summary for all detected packages.
1111Overview
1212--------
1313
14- Previously, we computed the summary at the codebase level, which included elements like the
14+ Previously, we computed the summary at the codebase level, which included elements like the
1515`license_clarity_score `, `declared_holder `, `other_license_expressions `, and more.
1616This project aims to improve scanning accuracy by computing summaries and license clarity scores for
1717each package and its files, rather than for the entire scan. This involves enhancing package models
@@ -22,16 +22,18 @@ Implementation
2222
2323All the work I did is contained in `this single PR <https://github.com/aboutcode-org/scancode-toolkit/pull/3792 >`_.
2424I added a new command-line option called ``--package-summary `` that users can employ to obtain
25- a package-level summary within a single codebase. The package level summary involves the
25+ a package-level summary within a single codebase. The package level summary involves the
2626``license_clarity_score `` calculation and population of package attributes like ``copyright ``,
27- ``holder ``, ``other_license_expression ``, ``notice_text ``. This option must be called with ``--classify ``
28- option that helps ScanCode further classify scanned files/directories, to determine whether
29- they fall in these categories `legal `, `readme `, `top-level `, `manifest ` & ``--package `` or ``-p `` option
30- detects various package manifests, lockfiles and package-like data and then assembles codebase level packages
31- and dependencies from these package data detected at files. Also tags files if they are part of the packages.
27+ ``holder ``, ``other_license_expression ``, ``notice_text ``. This option must be called
28+ with ``--classify `` option that helps ScanCode further classify scanned files/directories,
29+ to determine whether they fall in these categories `legal `, `readme `, `top-level `, `manifest `
30+ & ``--package `` or ``-p `` option detects various package manifests, lockfiles and
31+ package-like data and then assembles codebase level packages and dependencies from
32+ these package data detected at files. Also tags files if they are part of the packages.
3233
33- This change allows users to get the more refined summary for each individual package that is present in a codebase.
34- Also this feature improves the package assembly for various package ecosystems like npm, python-whl, rust, rubygems etc.
34+ This change allows users to get the more refined summary for each individual package
35+ that is present in a codebase. Also this feature improves the package assembly for
36+ various package ecosystems like npm, python-whl, rust, rubygems etc.
3537
3638
3739Finally, all these changes are tested through multiple unit tests validating both correct
@@ -63,5 +65,5 @@ I would like to thank my mentors
6365- `@35C4n0r <https://github.com/35C4n0r >`_
6466- `@jono-yang <https://github.com/JonoYang >`_
6567
66- Weekly calls were greatly helpful and those special 1:1 call with ` @AyanSinhaMahapatra ` and ` @pombredanne `
67- were so amazing. Thank you for your time and your patience!
68+ Weekly calls were greatly helpful and those special 1:1 call with
69+ ` @AyanSinhaMahapatra ` and ` @pombredanne ` were so amazing. Thank you for your time and your patience!
0 commit comments