feat: leaderboard-for-sns (#10)

- docs: leaderboard column (f70205de62c6e1a42262e22d83123568d71a8fdb)
- feat: leaderboard (e8c5ed74451af40c9eedfe1ed01abb3d5516344f)
- fix: only contributors between hackathon dates (b214b0b511bd528a5391f286e2d2ba51864e3595)
- feat: add twitter button (c6ad687ef9ce4e651adf7ddfb368196215bdda62)
- fix: to prod settings (abc803b8e3ae2ccaf844fd9296cfc2015195ddad)

.gitignore

@@ -1 +1,2 @@
-.env
+.env
+__pycache__

app.py

@@ -4,11 +4,12 @@ from huggingface_hub.repocard import metadata_load
 from gradio_client import Client
 from PIL import Image, ImageDraw, ImageFont
 
-from datetime import date
+from datetime import datetime, timezone, timedelta
 import time
 
 import os
 import sys
+from collections import defaultdict
 import pandas as pd
 import json
 import shutil
@@ -22,6 +23,9 @@ CERTIFIED_USERS_FILENAME = "certified.csv"
 
 ORGANIZATION = "pseudolab"
 
+START_DATE = datetime(2023, 10, 20, tzinfo=timezone(timedelta(hours=9)))
+END_DATE = datetime(2023, 11, 10, tzinfo=timezone(timedelta(hours=9)))
+
 
 def has_contributions(repo_type, hf_username, organization, likes=10):
     """
@@ -38,7 +42,7 @@ def has_contributions(repo_type, hf_username, organization, likes=10):
     }
 
     for repo in repo_list[repo_type](author=organization):
-        if len(api.list_repo_likers(repo.id, repo_type=repo_type)) < likes:
+        if repo.likes < likes:
             continue
         commits = api.list_repo_commits(repo.id, repo_type=repo_type)
         if any(hf_username in commit.authors for commit in commits):
@@ -69,10 +73,11 @@ def check_if_passed(hf_username):
     certificate_type = ""
 
     # If the user contributed to models, datasets and spaces then assign excellence
-    if all(get_hub_footprint(hf_username, ORGANIZATION)):
+    has_models, has_datasets, has_spaces = get_hub_footprint(hf_username, ORGANIZATION)
+    if all(has_models, has_datasets, has_spaces):
         passed = True
         certificate_type = "excellence"
-    elif any(get_hub_footprint(hf_username, ORGANIZATION)):
+    elif any(has_models, has_datasets, has_spaces):
         passed = True
         certificate_type = "completion"
 
@@ -230,7 +235,7 @@ def create_certificate(passed, certificate_type, hf_username, first_name, last_n
         Since you contributed to at least one model, dataset, or space- you get a Certificate of Completion 🎓.
         You can download your certificate below ⬇️
         https://huggingface.co/datasets/pseudolab/huggingface-krew-hackathon2023/resolve/main/certificates/{hf_username}.pdf\n
-        Don't hesitate to share your certificate link above on Twitter and Linkedin (you can tag me @wonhseo, @pseudo-lab and @huggingface) 🤗 \n
+        Don't hesitate to share your certificate link above on Twitter and Linkedin (you can tag me @wonhseo and @huggingface) 🤗
         You can try to get a Certificate of Excellence if you contribute to all types of repos, please don't hesitate to do so.
         """
     else:
@@ -261,38 +266,147 @@ def certification(hf_username, first_name, last_name):
     return message, pdf, certificate, output_row.update(visible=visible)
 
 
-with gr.Blocks() as demo:
-    gr.Markdown(
-        f"""
-    # Get your 2023 Hackathon Certificate 🎓
-    The certification process is completely free:
-    - To get a *certificate of completion*: you need to **contribute to at least one model, dataset, or space**.
-    - To get a *certificate of excellence*: you need to **contribute to models, datasets, and spaces**. *(Yes, all three!)*
-    
-    For more information about the certification process [check the hackathon page on certification](https://pseudo-lab.github.io/huggingface-hackathon23/submit.html#certification).
+def make_clickable_repo(name, repo_type):
+    if repo_type == "space":
+        link = "https://huggingface.co/" + "spaces/" + name
+    elif repo_type == "model":
+        link = "https://huggingface.co/"  + name
+    elif repo_type == "dataset":
+        link = "https://huggingface.co/" + "datasets/" + name
+    return f'<a target="_blank" href="{link}">{name.split("/")[-1]}</a>'
+
+
+def make_clickable_user(user_id):
+    link = "https://huggingface.co/" + user_id
+    return f'<a  target="_blank" href="{link}">{user_id}</a>'
+
+
+def leaderboard():
+    """
+    Get the leaderboard of the hackathon.
     
-    Don't hesitate to share your certificate on Twitter (tag me [@wonhseo](https://twitter.com/wonhseo), [@pseudo-lab](https://twitter.com/pseudo-lab), and [@huggingface](https://twitter.com/huggingface)) and on LinkedIn.
+    The leaderboard is a Pandas DataFrame with the following columns:
+    - Rank: the rank of the user in the leaderboard
+    - User: the Hugging Face username of the user
+    - Contributions: the list of contributions of the user (models, datasets, spaces)
+    - Likes: the total number of likes of the user's contributions
     """
-    )
+    repo_list = {
+        'model': api.list_models,
+        'dataset': api.list_datasets,
+        'space': api.list_spaces
+    }
 
-    hf_username = gr.Textbox(
-        placeholder="wseo", label="Your Hugging Face Username (case sensitive)"
-    )
-    first_name = gr.Textbox(placeholder="Wonhyeong", label="Your First Name")
-    last_name = gr.Textbox(placeholder="Seo", label="Your Last Name")
+    # Repos that should not be included in the leaderboard
+    not_included = [
+        'README',
+        '2023-Hackathon-Certification',
+        'huggingface-krew-hackathon2023',
+        # template repos as well
+    ]
 
-    check_progress_button = gr.Button(value="Check if I pass and get the certificate")
-    output_text = gr.components.Textbox(label="Your Result")
+    contributions = defaultdict(list)
+
+    for repo_type in repo_list:
+        for repo in repo_list[repo_type](author=ORGANIZATION):
+            if repo.id.split('/')[-1] in not_included:
+                continue
+            commits = api.list_repo_commits(repo.id, repo_type=repo_type)
+            for author in set(author for commit in commits if START_DATE < commit.created_at < END_DATE for author in commit.authors):
+                contributions[author].append((repo_type, repo.id, repo.likes))
+
+    leaderboard = []
+    for user, repo_likes in contributions.items():
+        repos = []
+        user_likes = 0
+        for repo_type, repo, likes in repo_likes:
+            repos.append(make_clickable_repo(repo, repo_type))
+            user_likes += likes
+        leaderboard.append([make_clickable_user(user), '- ' + '\n- '.join(repos), user_likes])
+    
+    df = pd.DataFrame(data=leaderboard, columns=["User 👤", "Contributions 🛠️", "Likes ❤️"])
+    df.sort_values(by=["Likes ❤️"], ascending=False, inplace=True)
+    df.insert(0, "Rank 🏆", list(range(1, len(df) + 1)))
+    
+    return df
 
-    with gr.Row(visible=True) as output_row:
-        output_pdf = gr.File()
-        output_img = gr.components.Image(type="pil")
 
-    check_progress_button.click(
-        fn=certification,
-        inputs=[hf_username, first_name, last_name],
-        outputs=[output_text, output_pdf, output_img, output_row],
+with gr.Blocks() as demo:
+    gr.Markdown(
+        '<img style="display: block; margin-left: auto; margin-right: auto; height: 10em;"'
+            ' src="file/hfkr_logo.png"/>\n\n'
+        '<h1 style="text-align: center;">Hugging Face KREW Hackathon 2023: Everyday AI</h1>'
     )
-
+    with gr.Row():
+        with gr.Column() as certificate_column:
+            gr.Markdown(
+                f"""
+                ## Get your 2023 Hackathon Certificate 🎓
+                The certification process is completely free:
+                - To get a *certificate of completion*: you need to **contribute to at least one model, dataset, or space**.
+                - To get a *certificate of excellence*: you need to **contribute to models, datasets, and spaces**. *(Yes, all three!)*
+                
+                For more information about the certification process [check the hackathon page on certification](https://pseudo-lab.github.io/huggingface-hackathon23/tutorials/project-roadmap.html#certification).
+                Don't hesitate to share your certificate on Twitter (tag me [@wonhseo](https://twitter.com/wonhseo) and [@huggingface](https://twitter.com/huggingface)) and on LinkedIn.
+                """
+            )
+
+            hf_username = gr.Textbox(
+                placeholder="wseo", label="Your Hugging Face Username (case sensitive)"
+            )
+            first_name = gr.Textbox(placeholder="Wonhyeong", label="Your First Name")
+            last_name = gr.Textbox(placeholder="Seo", label="Your Last Name")
+
+            check_progress_button = gr.Button(value="Check if I pass and get the certificate")
+            output_text = gr.components.Textbox(label="Your Result")
+
+            with gr.Row(visible=True) as output_row:
+                output_pdf = gr.File()
+                output_img = gr.components.Image(type="pil")
+
+            check_progress_button.click(
+                fn=certification,
+                inputs=[hf_username, first_name, last_name],
+                outputs=[output_text, output_pdf, output_img, output_row],
+            )
+        with gr.Column() as leaderboard_column:
+            gr.Markdown(
+                f"""
+                ## ❤️ Leaderboard
+                The leaderboard showcases your contributions for easy sharing on SNS platforms:
+                
+                - Event #1: *1 repo 1 share* - **share your contributions to the world!**
+                - (more on the way!)
+                
+                For more information about the offline event [check our event-us page](https://event-us.kr/huggingfacekrew/event/72612).
+                Don't hesitate to share your contributions on Twitter (tag me [@wonhseo](https://twitter.com/wonhseo) and [@huggingface](https://twitter.com/huggingface)) and on LinkedIn.
+
+                <a class="twitter-share-button" data-size="large"
+                   data-text="I'm participating in the Hugging Face KREW Hackathon 2023: Everyday AI! @wonhseo @huggingface"
+                   data-url="https://huggingface.co/spaces/pseudolab/2023-Hackathon-Certification"
+                   data-hashtags="huggingface,krewhackathon2023"
+                   href="https://twitter.com/intent/tweet">
+                Tweet</a>
+                """
+            )
+            with gr.Row():
+                repos_data = gr.components.Dataframe(
+                    type="pandas", datatype=["number", "markdown", "markdown", "number"]
+                )
+            with gr.Row():
+                data_run = gr.Button("Refresh")
+                data_run.click(
+                    leaderboard, outputs=repos_data
+                )
+
+    scripts = """
+    async () => {
+        const twitter = await import("https://platform.twitter.com/widgets.js");
+        globalThis.twitter = twitter;
+    }
+    """
+    
+    demo.load(leaderboard, outputs=repos_data)
+    demo.load(None, None, None, _js=scripts)
 
 demo.launch(debug=True)