gitcomp
A simple python package with a CLI to compare GitHub users and repositories by associating a git_score to each entry which is a weighted sum of features mapped to a score. git_score for a user is calculated on the basis of followers, followers to following ratio, number of public gists and number of organisations a user is part of. For a public repository, the determining factors are number of forks, if the repository itself is forked or not, number of stars and number of watchers.
Installation
Install via pip:
pip install gitcomp
usage: gitcomp [-h] [-u user_name [user_name ...] | -r repo [repo ...]] [-t output_t] [-o out]
gitcomp A CLI utility to compare the vital stats of GitHub repositories
optional arguments:
-h, --help show this help message and exit
-u user_name [user_name ...], --user user_name [user_name ...]
-u, --user
The GitHub username(s) to query against.
Multiple usernames can be queried at a time by providing a space
separated argument list.
-r repo [repo ...], --repo repo [repo ...]
-r, --repo
The public GitHub repository to query against
where repo takes the form:
Example: -r octocat/Spoon-Knife
-t output_t, --type output_t
-t, --type
Default: ascii. Choose the format of output.
All output is dumped to STDOUT unless output file is specified
using -o, --output flag.
The types available are: json: Show the result as JSON
csv: Format the output to CSV
ascii: Show the result as an ASCII Table
html: Show output as HTML Table
-o out, --output out -o, --output
Output to out_file, defaults to STDOUT.
Examples
Comparing Users
gitcomp -u Rohitrajak1807 avaish1409
Comparing Repositories
gitcomp -r avaish1409/VideoChatBot Rohitrajak1807/algorithms
Specifying output type
- ASCII Table (Default)
gitcomp -u Rohitrajak1807 avaish1409 -t ASCII
- JSON
gitcomp -u Rohitrajak1807 avaish1409 -t json
- CSV
gitcomp -u Rohitrajak1807 avaish1409 -t csv
- HTML Table
gitcomp -u Rohitrajak1807 avaish1409 -t html
Specifying output file
gitcomp -u Rohitrajak1807 avaish1409 -t json -o res.json
gitcomp -u Rohitrajak1807 avaish1409 -t csv -o res.csv
gitcomp -u Rohitrajak1807 avaish1409 -t html -o res.html
gitcomp -u Rohitrajak1807 avaish1409 -o res.txt
History
See release notes for changes https://github.com/avaish1409/gitcomp/releases
Development pattern for contributors
- Create a fork of the main gitcomp repository on GitHub.
- Make your changes in a branch named something different from
mainand titled as per your contribution, e.g. create a new branchdocumentation-fixes. - Create a pull request.
- Please follow the Python style guide for PEP-8.
License
gitcomp is licensed under the MIT License.
17 Dec 11, 2022
150 Dec 14, 2022
1 Oct 2, 2022
11 Aug 10, 2022
5 Apr 12, 2022
14.5k Jan 3, 2023
37 Dec 15, 2022
22 Dec 5, 2022
5.8k Jan 3, 2023
20 Jun 21, 2021
2k Jan 7, 2023
1.3k Dec 28, 2022
30 Sep 8, 2022
1 Oct 28, 2021
0 Nov 2, 2021
2 Dec 28, 2021
0 Sep 28, 2021
13 Nov 8, 2022
446 Dec 21, 2022