bot-replication/code/bot_detection
623756217 1d6cc94be5 update code/data 2022-03-22 23:31:36 +08:00
..
.gitignore update code/data 2022-03-22 23:31:36 +08:00
LICENSE.txt update code/data 2022-03-22 23:31:36 +08:00
MANIFEST.in update code/data 2022-03-22 23:31:36 +08:00
README.md update code/data 2022-03-22 23:31:36 +08:00
bodegha.py update code/data 2022-03-22 23:31:36 +08:00
github-tokens-example.txt update code/data 2022-03-22 23:31:36 +08:00
model.json update code/data 2022-03-22 23:31:36 +08:00
process_bodegha.py update code/data 2022-03-22 23:31:36 +08:00
repo-list-handled.txt update code/data 2022-03-22 23:31:36 +08:00
repo-list.txt update code/data 2022-03-22 23:31:36 +08:00
requirement.txt update code/data 2022-03-22 23:31:36 +08:00
setup.cfg update code/data 2022-03-22 23:31:36 +08:00
setup.py update code/data 2022-03-22 23:31:36 +08:00

README.md

Bot_Detection

#Installation pip install git+https://github.com/mehdigolzadeh/BoDeGHa

#Usage --accounts [ACCOUNT [ACCOUNT ...]] User login of one or more accounts

Example: $ bodegha repo_owner/repo_name --accounts mehdigolzadeh alexandredecan tommens --key

By default all accounts in the repository will be analysed

--start-date START_DATE Start date of pull request and issue comments in the repository to be considered

Example: $ bodegha repo_owner/repo_name --start-date 01-01-2018 --key

_The default start-date is 6 months before the current date.

--verbose To have verbose output result

Example: $ bodegha repo_owner/repo_name --verbose --key

The default value is false, if you don't pass this parameter the output will only be the accounts and their type

--min-comments MIN_COMMENTS Minimum number of pull request and issue comments that are required to analyze an account

Example: $ bodegha repo_owner/repo_name --min-comments 20 --key

The default value is 10 comments (the reason explained earlier in this file)

--max-comments MAX_COMMENTS Maximum number of pull request and issue comments to be considered for each account (default=100)

Example: $ bodegha repo_owner/repo_name --max-comments 120 --key

The default value is 100 comments (the reason explained earlier in this file)

--key APIKEY GitHub personal access token required to download comments from GitHub GraphQL API This parameter is mandatory and you can obtain an access token as described earlier

--text Output results as plain text --csv Output results in comma-separated values (csv) format --json Output results in json format

Example: $ bodegha repo_owner/repo_name --json --key

This group of parameters is the type of output, e.g., if you pass --json you will get the result in JSON format

--exclude [ACCOUNT [ACCOUNT ...]] List of accounts to be excluded from the analysis

Example: $ bodegha repo_owner/repo_name --exclude mehdigolzadeh alexandredecan tommens --key

--only-predicted Only list accounts that the prediction is available

Example: $ bodegha repo_owner/repo_name --only-predicted