spdx / license-coverage-grader Goto Github PK

@goneall add this as a description to the repo "This is a tool which take an SPDX document and pointer to the original source files, and determine a "grade" score to quantify how complete the licensing information is at the file level for the code represented by the SPDX document. "

For topics you could just add 'license-coverage', 'license-grader', 'licence' and 'spdx'

This code already contain some unit test. Adding more automated unit tests will do it some good

@krysnuvadga @kestewart @pombredanne

I noticed that the develop branch is behind master by 4 commits. That even prompted me to make a pull request #8 on the Master branch, which I think is not the best of practices.

I propose we take the develop branch to the same level as the master branch.

Initially we have used ‘cloc’ to scan and analyse the source package for valid lines of code. Given that ‘cloc’ has its downsides which rendered some results inaccurate, a new python tool tailored to be integrated with the license coverage grader instead of cloc will be a plus.

To eliminate the long and tedious integration process, it will be good practice to integrate Travis CI with this repo

For instance,
3- Clone the repository
git clone https://github.com/krysnuvadga/license-coverage-grader.git

But probably best to check through all documentation and adjust paths, etc.

Maybe I understand the README wrongly, but from how it reads, I fear that after installing license-coverage-grader, the command names would be too generic and therefore confusing or even clashing with some other commands on the system.

Therefore I would propose to rename them as follows:

• grade ↦ spdx-coverage-grade
• scan ↦ spdx-coverage-scan
• check ↦ spdx-coverage-check
• analyse ↦ spdx-coverage-analyse

You can probably think of a more meaningful name for at least the last three commands. I just wanted to mention what could potentially be an issue.

Great to see this tool exist, BTW! Kudos 👍

Description

Rename cmds.py with a more descriptive name. By 'descriptive', the name should reflect the content of the file in relation to the project objective

Most of the classes and methods are missing python document string. Adding docstring to these class and methods will be good for code maintenance and readability