admin/SecLists
1
0
Fork 0
mirror of https://github.com/danielmiessler/SecLists.git synced 2025-06-01 11:11:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added script that formats readme

Browse Source
This commit is contained in:
Mo Langning 2023-11-26 21:50:17 +08:00
parent 71b83f9515
commit c321cad02e
1 changed files with 77 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
.bin/get-and-patch-readme-repository-details.py Executable file
View File

@ -0,0 +1,77 @@
#!/usr/bin/python3
# If you change the commit message you need to change .github/workflows/readme-updater.yml
import requests,re
REPOSITORY_API="https://api.github.com/repos/%s"
REPOSITORY="danielmiessler/SecLists"
REPOSITORY_COMMITS_API="https://api.github.com/repos/%s/commits"
REPOSITORY_COMMIT_URL="https://github.com/%s/commit/%s"
DETAILS_ANCHOR="<!--- details anchor -->"
DETAILS_ANCHOR_REGEX=r"%s.*?%s"%(DETAILS_ANCHOR,DETAILS_ANCHOR)
COMMIT_MESSAGE="[Github Action] Automated readme update."
DETAIL_USER_NOTICE_STRING="""%s
### Repository details
Size of a complete clone of SecLists is currently at `%s`
Latest [commit](%s) was made on %s by %s
Cloning this repository should take %i-%i minutes at 5MB/s speeds.
%s
"""
size=requests.get(REPOSITORY_API%(REPOSITORY)).json()['size'] # Its in kb
suffixes=['MB','GB','TB']
final_size=[str(size),"","KB"]
for i in suffixes:
if len(final_size[0])>3:
final_size[1]=final_size[0][-3:]+final_size[1]
final_size[0]=final_size[0][:-3]
final_size[2]=i
trailing_nums=list(final_size[1])
decimal_len=3-len(final_size[0])
if int(trailing_nums[decimal_len])>=5:
trailing_nums[decimal_len-1]=str(int(trailing_nums[decimal_len-1])+1)
trailing_nums=''.join(trailing_nums)
trailing_nums=trailing_nums[:decimal_len]
final_size=final_size[0]+'.'+trailing_nums+' '+final_size[2]
eta_lower_bound=int(str(size/5000/60).split('.')[0]) # Get whole number after decimal point
eta_upper_bound=eta_lower_bound+1
commit_author=""
commit_hash=""
commit_date=""
commits=requests.get(REPOSITORY_COMMITS_API%(REPOSITORY)).json()
for commit in commits:
if commit["commit"]["message"].startswith("Merge pull request") and commit["commit"]["committer"]=="Github":
continue
commit_author=commit['commit']['author']['name']
commit_hash=commit['sha']
commit_date=commit['commit']['author']['date'].split('T')[0]
REPOSITORY_COMMIT_URL=REPOSITORY_COMMIT_URL%(REPOSITORY,commit_hash)
DETAIL_USER_NOTICE_STRING=DETAIL_USER_NOTICE_STRING%(DETAILS_ANCHOR,final_size,REPOSITORY_COMMIT_URL,commit_date,commit_author,eta_lower_bound,eta_upper_bound,DETAILS_ANCHOR)
readme_contents=open("README.md").read()
if re.match(DETAILS_ANCHOR_REGEX,readme_contents,flags=re.DOTALL):
print("[!] Error: No details anchor found!")
exit(2)
readme_contents=re.sub(DETAILS_ANCHOR_REGEX,DETAIL_USER_NOTICE_STRING,readme_contents,flags=re.DOTALL)
open("README.md","w").write(readme_contents)