Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Format Python script using Black formatter #1202

Merged
merged 11 commits into from
Jan 29, 2024
Merged

Format Python script using Black formatter #1202

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5b198c6
Format Python script using Black formatter
za Jan 26, 2024
692f1c9
Update github workflows pre-commit to add black in the workflow
za Jan 26, 2024
f69e455
Added black.yml for github actions integrations
za Jan 26, 2024
357f04e
Rename Lint to Black
za Jan 26, 2024
1621238
Update .pre-commit-config.yaml to add black
za Jan 26, 2024
64b2905
Merge branch 'master' into python-black-formatted
commjoen Jan 28, 2024
340a593
Merge branch 'master' into python-black-formatted
commjoen Jan 28, 2024
fb37618
Update black version
za Jan 29, 2024
7cc3112
Merge branch 'master' into python-black-formatted
commjoen Jan 29, 2024
cc0061e
Removed black github workflow
za Jan 29, 2024
d704f94
Merge branch 'python-black-formatted' of github.com:za/wrongsecrets i…
za Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
242 changes: 141 additions & 101 deletions scripts/sort_contibutors/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,83 +10,117 @@
def print_file(s: str, flag: bool) -> None:
# True for MD , false for HTML file
if flag:
f = open('contributors_file.md', 'w')
f = open("contributors_file.md", "w")
f.write(s)
return
f = open('contributors_file.html', 'w')
f = open("contributors_file.html", "w")
f.write(s)


def print_md(user_list: dict, label="") -> str:
string = '{}:\n\n'.format(label)
string = "{}:\n\n".format(label)
for value in user_list:
string += '- [{} @{}](https://www.github.com/{})\n'.format(value['name'],
value['username'], value['username'])
return string + '\n'


def print_html(leaders: dict, top_contributors: dict, contributors: dict, testers: dict, special_thanks: dict) -> str:
string = '<html><head></head><body>\n'

string += 'OWASP Project Leaders:\n'
string += '<ul>\n'
string += "- [{} @{}](https://www.github.com/{})\n".format(
value["name"], value["username"], value["username"]
)
return string + "\n"


def print_html(
leaders: dict,
top_contributors: dict,
contributors: dict,
testers: dict,
special_thanks: dict,
) -> str:
string = "<html><head></head><body>\n"

string += "OWASP Project Leaders:\n"
string += "<ul>\n"
for value in leaders:
string += '<li><a href=\'https://www.github.com/{}\'>{} @{}</a></li>\n'.format(
value['username'], value['name'], value['username'])
string += '</ul>\n'
string += "<li><a href='https://www.github.com/{}'>{} @{}</a></li>\n".format(
value["username"], value["name"], value["username"]
)
string += "</ul>\n"

string += 'Top Contributors:\n'
string += '<ul>\n'
string += "Top Contributors:\n"
string += "<ul>\n"
for value in top_contributors:
string += '<li><a href=\'https://www.github.com/{}\'>{} @{}</a></li>\n'.format(
value['username'], value['name'], value['username'])
string += '</ul>\n'
string += "<li><a href='https://www.github.com/{}'>{} @{}</a></li>\n".format(
value["username"], value["name"], value["username"]
)
string += "</ul>\n"

string += 'Contributors:\n'
string += '<ul>\n'
string += "Contributors:\n"
string += "<ul>\n"
for value in contributors:
string += '<li><a href=\'https://www.github.com/{}\'>{} @{}</a></li>\n'.format(
value['username'], value['name'], value['username'])
string += '</ul>\n'
string += "<li><a href='https://www.github.com/{}'>{} @{}</a></li>\n".format(
value["username"], value["name"], value["username"]
)
string += "</ul>\n"

string += 'Testers:\n'
string += '<ul>\n'
string += "Testers:\n"
string += "<ul>\n"
for value in testers:
string += '<li><a href=\'https://www.github.com/{}\'>{} @{}</a></li>'.format(
value['username'], value['name'], value['username'])
string += '</ul>\n'
string += "<li><a href='https://www.github.com/{}'>{} @{}</a></li>".format(
value["username"], value["name"], value["username"]
)
string += "</ul>\n"

string += 'Special mentions for helping out:\n'
string += '<ul>\n'
string += "Special mentions for helping out:\n"
string += "<ul>\n"
for value in special_thanks:
string += '<li><a href=\'https://www.github.com/{}\'>{} @{}</a></li>\n'.format(
value['username'], value['name'], value['username'])
string += '</ul>\n'
string += "<li><a href='https://www.github.com/{}'>{} @{}</a></li>\n".format(
value["username"], value["name"], value["username"]
)
string += "</ul>\n"

string += '</body><html>\n'
string += "</body><html>\n"
return string


def parse_contributor_list(user_list: list, user_token: str) -> list:
contributors = []

for element in user_list:
ranking = element['contributions']
username = element['login']
ranking = element["contributions"]
username = element["login"]
name = get_fullname(username, user_token)
if name == None:
name = username

leaders_and_multijuicer = ['DerGut', 'bkimminich', 'MichaelEischer', 'rseedorff', 'jonasbg', 'scornelissen85',
'zadjadr', 'stuebingerb', 'sydseter', 'troygerber', 'skandix', 'saymolet',
'adrianeriksen', 'pseudobeard', 'coffemakingtoaster', 'wurstbrot', 'blucas-accela',
'fwijnholds', 'stefan-schaermeli', 'nickmalcolm', 'orangecola', 'commjoen',
'bendehaan', 'benno001']
leaders_and_multijuicer = [
"DerGut",
"bkimminich",
"MichaelEischer",
"rseedorff",
"jonasbg",
"scornelissen85",
"zadjadr",
"stuebingerb",
"sydseter",
"troygerber",
"skandix",
"saymolet",
"adrianeriksen",
"pseudobeard",
"coffemakingtoaster",
"wurstbrot",
"blucas-accela",
"fwijnholds",
"stefan-schaermeli",
"nickmalcolm",
"orangecola",
"commjoen",
"bendehaan",
"benno001",
]

# Filter the github bots
if '[bot]' not in username and username not in leaders_and_multijuicer:
if "[bot]" not in username and username not in leaders_and_multijuicer:
contributors.append(
{'username': username, 'name': name, 'ranking': ranking})
{"username": username, "name": name, "ranking": ranking}
)

return contributors

Expand All @@ -103,26 +137,34 @@ def get_fullname(username: str, user_token: str) -> str:
}
if username in name_dict:
return name_dict[username]
headers = {'X-GitHub-Api-Version': '2022-11-28',
'Accept': 'application/vnd.github+json',
'Authorization': 'Bearer ' + user_token}
r = requests.get('https://api.github.com/users/' +
username, headers=headers, timeout=20)
headers = {
"X-GitHub-Api-Version": "2022-11-28",
"Accept": "application/vnd.github+json",
"Authorization": "Bearer " + user_token,
}
r = requests.get(
"https://api.github.com/users/" + username, headers=headers, timeout=20
)
if r.status_code == 401:
print("Invalid token")
os._exit(-1)
return r.json()['name']
return r.json()["name"]


# Retrieves the list of contributors of a repository in JSON format


def fetch_repository(project: str, user_token: str) -> list:
headers = {'X-GitHub-Api-Version': '2022-11-28',
'Accept': 'application/vnd.github+json',
'Authorization': 'Bearer ' + user_token}
r = requests.get('https://api.github.com/repos/OWASP/' +
project + '/contributors?per_page=100', headers=headers, timeout=20)
headers = {
"X-GitHub-Api-Version": "2022-11-28",
"Accept": "application/vnd.github+json",
"Authorization": "Bearer " + user_token,
}
r = requests.get(
"https://api.github.com/repos/OWASP/" + project + "/contributors?per_page=100",
headers=headers,
timeout=20,
)
if r.status_code == 401:
print("Invalid token")
os._exit(-1)
Expand All @@ -134,24 +176,24 @@ def merge_users(l: list) -> list:
ranking = dict()

for a in l:

if a['username'] in ranking:
ranking[a['username']] += a['ranking']
if a["username"] in ranking:
ranking[a["username"]] += a["ranking"]
else:
ranking[a['username']] = a['ranking']
username[a['username']] = {'username': a['username'],
'name': a['name'], 'ranking': ranking[a['username']]}
ranking[a["username"]] = a["ranking"]
username[a["username"]] = {
"username": a["username"],
"name": a["name"],
"ranking": ranking[a["username"]],
}

l = dict(sorted(username.items(),
key=lambda x: x[1]['ranking'], reverse=True))
l = dict(sorted(username.items(), key=lambda x: x[1]["ranking"], reverse=True))

special_contributors = []
contributors = []

for key, value in l.items():
element = {'name': value['name'],
'username': key, 'ranking': value['ranking']}
if element['ranking'] >= 100:
element = {"name": value["name"], "username": key, "ranking": value["ranking"]}
if element["ranking"] >= 100:
special_contributors.append(element)
else:
contributors.append(element)
Expand All @@ -160,14 +202,12 @@ def merge_users(l: list) -> list:

def get_contibutors_list(token: str) -> list:
print("[+] Fetching the Wrong Secrets CTF party contributors list ... ")
wrongsecrets_ctf_list = fetch_repository('wrongsecrets-ctf-party', token)
wrongsecrets_ctf_list = fetch_repository("wrongsecrets-ctf-party", token)
print("[+] Fetching the Wrong Secrets Binaries contributors list ... ")
wrongsecrets_binaries_list = fetch_repository(
'wrongsecrets-binaries', token)
wrongsecrets_binaries_list = fetch_repository("wrongsecrets-binaries", token)
print("[+] Fetching the Wrong Secrets contributors list ... ")
wrongsecrets_list = fetch_repository('wrongsecrets', token)
merged_list = wrongsecrets_binaries_list + \
wrongsecrets_ctf_list + wrongsecrets_list
wrongsecrets_list = fetch_repository("wrongsecrets", token)
merged_list = wrongsecrets_binaries_list + wrongsecrets_ctf_list + wrongsecrets_list
print("[+] Sorting the list .. ")
return merge_users(merged_list)

Expand All @@ -178,55 +218,55 @@ def get_contibutors_list(token: str) -> list:

# Loads the .env file
load_dotenv()
token = os.getenv('USER_TOKEN')
token = os.getenv("USER_TOKEN")

if token is not None:

contributors = [
{'username': 'f3rn0s', 'name': 'f3rn0s'},
{'username': 'szh', 'name': 'Shlomo Zalman Heigh'},
{"username": "f3rn0s", "name": "f3rn0s"},
{"username": "szh", "name": "Shlomo Zalman Heigh"},
]

testers = [
{'username': 'davevs', 'name': 'Dave van Stein'},
{'username': 'drnow4u', 'name': 'Marcin Nowak'},
{'username': 'mchangsp', 'name': 'Marc Chang Sing Pang'},
{'username': 'djvinnie', 'name': 'Vineeth Jagadeesh'}
{"username": "davevs", "name": "Dave van Stein"},
{"username": "drnow4u", "name": "Marcin Nowak"},
{"username": "mchangsp", "name": "Marc Chang Sing Pang"},
{"username": "djvinnie", "name": "Vineeth Jagadeesh"},
]
leaders = [
{'username': 'bendehaan', 'name': 'Ben de Haan'},
{'username': 'commjoen', 'name': 'Jeroen Willemsen'}
{"username": "bendehaan", "name": "Ben de Haan"},
{"username": "commjoen", "name": "Jeroen Willemsen"},
]
special_thanks = [
{'username': 'madhuakula', 'name': 'Madhu Akula @madhuakula'},
{'username': 'nbaars', 'name': 'Nanne Baars @nbaars'},
{'username': 'bkimminich', 'name': 'Björn Kimminich'},
{'username': 'devsecops', 'name': 'Dan Gora'},
{'username': 'saragluna', 'name': 'Xiaolu Dai'},
{'username': 'jonathanGiles', 'name': 'Jonathan Giles'},
{"username": "madhuakula", "name": "Madhu Akula @madhuakula"},
{"username": "nbaars", "name": "Nanne Baars @nbaars"},
{"username": "bkimminich", "name": "Björn Kimminich"},
{"username": "devsecops", "name": "Dan Gora"},
{"username": "saragluna", "name": "Xiaolu Dai"},
{"username": "jonathanGiles", "name": "Jonathan Giles"},
]

l = get_contibutors_list(token)
special_list = l[0]
normal_list = l[1]
l = merge_users(special_list + normal_list)

print('[+] Print to HTML file')
print("[+] Print to HTML file")
html_payload = print_html(leaders, l[0], l[1], testers, special_thanks)
print_file(html_payload, False)

print('[+] Print to MD file')
md_payload = print_md(leaders, 'Leaders')
md_payload += print_md(l[0], 'Top contributors')
md_payload += print_md(l[1], 'Contributors')
md_payload += print_md(testers, 'Testers')
md_payload += print_md(special_thanks, 'Special thanks')
print("[+] Print to MD file")
md_payload = print_md(leaders, "Leaders")
md_payload += print_md(l[0], "Top contributors")
md_payload += print_md(l[1], "Contributors")
md_payload += print_md(testers, "Testers")
md_payload += print_md(special_thanks, "Special thanks")
print_file(md_payload, True)

print('[+] Done')
print("[+] Done")
else:
print(
'The variable USER_TOKEN does not exists. You must setup the variable'
'in the following way:')
print('echo USER_TOKEN=github_pat_dfs1N_f>.env')
"The variable USER_TOKEN does not exists. You must setup the variable"
"in the following way:"
)
print("echo USER_TOKEN=github_pat_dfs1N_f>.env")
print('note that the USER_TOKEN requires "repository access" only')
Loading