Skip to content

Commit

Permalink
[docs] Update CoLic definition under documentation adn docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: inishchith <[email protected]>
  • Loading branch information
inishchith committed Aug 9, 2019
1 parent a2de446 commit 2495f9f
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ currently available backends are:
- **CoDep** extracts package and class dependencies of a Python module and serialized them as JSON structures, composed of edges and nodes, thus easing the bridging with front-end technologies for graph visualizations. It combines [PyReverse](https://pypi.org/project/pyreverse/) and [NetworkX](https://networkx.github.io/).
- **CoQua** retrieves code quality insights, such as checks about line-code’s length, well-formed variable names, unused imported modules and code clones. It uses [PyLint](https://www.pylint.org/) and [Flake8](http://flake8.pycqa.org/en/latest/index.html). The tools can be activated by passing the corresponding category: `code_quality_pylint` or `code_quality_flake8`.
- **CoVuln** scans the code to identify security vulnerabilities such as potential SQL and Shell injections, hard-coded passwords and weak cryptographic key size. It relies on [Bandit](https://github.com/PyCQA/bandit).
- **CoLic** scans the code to extract license information. It currently supports [Nomos](https://github.com/fossology/fossology/tree/master/src/nomos) and [ScanCode](https://github.com/nexB/scancode-toolkit). They can be activated by passing the corresponding category: `code_license_nomos`, `code_license_scancode`, or `code_license_scancode_cli`.
- **CoLic** scans the code to extract license & copyright information. It currently supports [Nomos](https://github.com/fossology/fossology/tree/master/src/nomos) and [ScanCode](https://github.com/nexB/scancode-toolkit). They can be activated by passing the corresponding category: `code_license_nomos`, `code_license_scancode`, or `code_license_scancode_cli`.
- **CoLang** gathers insights about code language distribution of a git repository. It relies on [Linguist](https://github.com/github/linguist) and [Cloc](http://cloc.sourceforge.net/) tools. They can be activated by passing the corresponding category: `code_language_linguist` or `code_language_cloc`.

### How to develop a backend
Expand Down
2 changes: 1 addition & 1 deletion bin/graal
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Repositories are reached using specific backends, which are:
cocom Fetch code complexity for many programming languages
codep Fetch package and class dependencies of Python modules
colang Fetch code language distribution
colic Fetch license information
colic Fetch license & copyright information
coqua Fetch code quality data of Python code
covuln Fetch security vulnerabilities in Python code
Expand Down
2 changes: 1 addition & 1 deletion graal/backends/core/colic.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
class CoLic(Graal):
"""CoLic backend.
This class extends the Graal backend. It gathers license information
This class extends the Graal backend. It gathers license & copyright information
using Nomos, Scancode or Scancode-cli
:param uri: URI of the Git repository
Expand Down

0 comments on commit 2495f9f

Please sign in to comment.