Opendigger command line is designed for CLI enthusiasts who wish to gather diverse information and metrics that evaluate the quality of open-source projects related to a GitHub repository. For detailed information about the index and metrics, please refer to this link.
Prerequisites: python3
environment, other PyPI packages like numpy
,plotext
and matplotlib
is requried to install if error like package not found occur.
pip install opendigger
opendigger -repo <owner>/<repo-name> -index openrank
,
e.g.opendigger -repo torvalds/linux -index openrank
opendigger -repo <owner>/<repo-name> -index activity
opendigger -repo <owner>/<repo-name> -index activity
opendigger -repo <owner>/<repo-name> -index all
Metrics option as follows:
[-metric {active-dates-times,stars,technical_fork,participants,contributors,bus_factor,issues,code_change_line,pr,network,all}]
if you want to show all the metrics, just choose all
, then opendigger will retrieve you all the metrics about that repo
If you incur error like this or error imply you that program run wrong:
HTTPError: 404 - Not Found
HTTPError: 404 - Not Found
please check your network connection and try again. If still failed, you should consider to check the metrics on opendigger GitHub repo by yourself. Sorry for the inconveniences.
You can see the example of the generated report in the examples directory in the Github Repo. link