Skip to content

Commit

Permalink
Merge pull request #96 from MZuhairKhan/master
Browse files Browse the repository at this point in the history 
Automated team.MD, closes #28
  • Loading branch information
@MaldoAlberto
MaldoAlberto authored Jun 10, 2024
2 parents 18ceee6 + 91edb35 commit 54774cc
Show file tree
Hide file tree
Showing 2 changed files with 141 additions and 3 deletions.
61 changes: 61 additions & 0 deletions qosf.org/scripts/contributors.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import re
import requests

# Constants for GitHub API
GITHUB_API = "https://api.github.com"
ORGANIZATION = "qosf"

def get_repos(org):
"""Get the list of repositories for the organization."""
url = f"{GITHUB_API}/orgs/{org}/repos"
response = requests.get(url)
return response.json() # This will return a list of repositories.

def get_contributors(repo):
"""Get the list of contributors for a repository."""
url = f"{GITHUB_API}/repos/{ORGANIZATION}/{repo}/contributors"
response = requests.get(url)
return response.json() # This will return a list of contributors.

def generate_contributor_snippet(contributor):
"""Generate the HTML snippet for a single contributor."""
# You would create the HTML snippet based on the structure in `team.md`
return "<li>" + contributor + "</li>"

def update_team_md(snippets):
"""Update the team.md file with a new list of contributors."""
with open("qosf.org/team.md", "r", encoding='utf-8') as file:
content = file.read()

# Define the start and end markers and the regex pattern to find the section
# Current implementation breaks if we have multiple html unnumbered lists
# Easy to fix if needed
start_marker = "<ul>"
end_marker = "</ul>"
pattern = re.compile(f"({re.escape(start_marker)}).*?({re.escape(end_marker)})", re.DOTALL)
# Join all contributors snippets into a single string
contributors_section = "\n\t\t".join(snippets)
# Replace the section between the markers with the new contributors' section
new_content = pattern.sub(rf"\1{contributors_section}\2", content)

# Write the updated content back to the file
with open("qosf.org/team.md", "w", encoding='utf-8') as file:
file.write(new_content)

def main():
repos = get_repos(ORGANIZATION)
all_contributors = {}

# Collect and sort contributors from all repos
for repo in repos:
for contributor in get_contributors(repo['name']):
all_contributors[contributor['login']] = contributor
sorted_contributors = list(dict(sorted(all_contributors.items())).keys())

# Generate HTML snippets for each contributor
snippets = [generate_contributor_snippet(contributor) for contributor in sorted_contributors]
# Update team.md
update_team_md(snippets)

if __name__ == "__main__":
main()
83 changes: 80 additions & 3 deletions qosf.org/team.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ micro_nav: false
</div>
<div class='col-md-8' style='text-align: justify;'>
<b>Michał Stęchły</b> got into open source thanks to quantum computing - when he discovered he can contribute to the quantum computing community as a newcomer to the field, he immediately fell in love with the idea. He authored and supported open source implementations and research of several quantum computing algorithms. Michał has also a blog <a href="https://www.mustythoughts.com">"Musty Thoughts"</a>, which aims to help people get into the realm of quantum computing. Professionally, he is a Quantum Software Engineer at <a href="https://www.zapatacomputing.com">Zapata Computing</a>.

</div>
</div>

Expand All @@ -74,7 +73,6 @@ micro_nav: false
</div>
<div class='col-md-8' style='text-align: justify;'>
<b>Maggie Li</b> loves all things open source, from science to software, as a believer in innovation through collaboration. She stepped into the world of open source software as a quantum computing amateur by contributing to <a href="https://github.com/XanaduAI/pennylane">PennyLane</a>, thanks to QOSF's Quantum Mentorship Program. Outside of quantum computing, she cares about healthcare and education accessibility.

</div>
</div>

Expand All @@ -91,13 +89,92 @@ micro_nav: false
<b>Peter Wittek<sup>&#8224;</sup></b> was a life-long fan of free and open source software who got furious every time he had to fill in a PDF form that did not work on Linux. When he was not preaching about the importance of open source software, he pursued research on the borderline of artificial intelligence and quantum physics as an Assistant Professor in the University of Toronto, and as an affiliate in the Vector Institute for Artificial Intelligence and the Perimeter Institute for Theoretical Physics. He also was the Academic Director of the Quantum Stream in the Creative Destruction Lab, where he saw dozens of startups exploring ideas using quantum computers and the corresponding software stack. In September 2019, he disappeared in an avalanche during a mountaineering expedition on Mt. Trishul in the Himalayas.
</div>
</div>
<br>

# Contributors

<div class="callout callout--info">
<p><strong>A big thank you to all the engaged Github/Gitlab contributors on all of our various repos! You are making QOSF possible!</strong>
Become a QOSF contributor by opening an issue or submitting a pull request on our <a href="https://github.com/qosf">GitHub</a> or <a href="https://gitlab.com/qosf">GitLab</a> page.
</p>
<p> Contributor list:
<ul><li>00mjk</li>
<li>1ucian0</li>
<li>BillyLjm</li>
<li>InfamousPlatypus</li>
<li>JoelPasvolsky</li>
<li>MaldoAlberto</li>
<li>MariaBat</li>
<li>MarkCunningham0410</li>
<li>Qottmann</li>
<li>Qubit1718</li>
<li>Roger-luo</li>
<li>SSdevelop</li>
<li>Shiro-Raven</li>
<li>Sinestro38</li>
<li>TerraVenil</li>
<li>TheGupta2012</li>
<li>Travis-S-IBM</li>
<li>VoicuTomut</li>
<li>aditya-giri</li>
<li>amirebrahimi</li>
<li>artix41</li>
<li>bestquark</li>
<li>boegel</li>
<li>contepablod</li>
<li>crazy4pi314</li>
<li>dangirsh</li>
<li>dependabot[bot]</li>
<li>desireevl</li>
<li>dhruvbhq</li>
<li>diemilio</li>
<li>dlyongemallo</li>
<li>dstrain115</li>
<li>dudalev</li>
<li>efratshabtai</li>
<li>enakai00</li>
<li>georgios-ts</li>
<li>giorgosgiapis</li>
<li>hay-k</li>
<li>hillmich</li>
<li>iamvamsikrishnad</li>
<li>ihincks</li>
<li>johnzl-777</li>
<li>josh146</li>
<li>kodaj</li>
<li>ksjin-git</li>
<li>lazyoracle</li>
<li>lkuligin</li>
<li>lvignoli</li>
<li>lzylili</li>
<li>mariaschuld</li>
<li>markf94</li>
<li>miguefalvarez</li>
<li>mkalis</li>
<li>mstechly</li>
<li>oscarhiggott</li>
<li>peguerosdc</li>
<li>peterwittek</li>
<li>prince-ph0en1x</li>
<li>rryoung98</li>
<li>rsln-s</li>
<li>saravsak</li>
<li>scarrazza</li>
<li>sikfeng</li>
<li>silky</li>
<li>spakin</li>
<li>stared</li>
<li>stewdio</li>
<li>tbabej</li>
<li>tjstavenger-pnnl</li>
<li>tlubowe</li>
<li>vic023</li>
<li>vprusso</li>
<li>vsoftco</li>
<li>willzeng</li>
<li>yardolabs</li>
<li>yourball</li></ul>
</p>
</div>

# Donors
Expand All @@ -106,4 +183,4 @@ micro_nav: false
<p><strong>Interested in funding QOSF's mission?</strong>
We're a not-for-profit charity and are looking for financial support in order to make the QOSF software grant program possible. If you're interested in supporting QOSF's mission financially, feel free to send us an <a href="mailto:[email protected]">email</a>.
</p>
</div>
</div>

0 comments on commit 54774cc

Please sign in to comment.