docs: format success message (#6)

- docs: format success message (dc596481ebf6b20273d80a1dddbeaf53e8a1ee2e)

app.py

@@ -5,7 +5,7 @@ from gradio_client import Client
 from PIL import Image, ImageDraw, ImageFont
 
 from datetime import date
-import time  
+import time
 
 import os
 import sys
@@ -31,9 +31,9 @@ def has_contributions(repo_type, hf_username, organization):
     :param organization: HF Hub organization
     """
     repo_list = {
-        'model': api.list_models,
-        'dataset': api.list_datasets,
-        'space': api.list_spaces
+        "model": api.list_models,
+        "dataset": api.list_datasets,
+        "space": api.list_spaces,
     }
 
     for repo in repo_list[repo_type](author=organization):
@@ -49,9 +49,9 @@ def get_hub_footprint(hf_username, organization):
     :param hf_username: HF Hub username
     :param organization: HF Hub organization
     """
-    has_models = has_contributions('model', hf_username, organization)
-    has_datasets = has_contributions('dataset', hf_username, organization)
-    has_spaces = has_contributions('space', hf_username, organization)
+    has_models = has_contributions("model", hf_username, organization)
+    has_datasets = has_contributions("dataset", hf_username, organization)
+    has_spaces = has_contributions("space", hf_username, organization)
 
     return (has_models, has_datasets, has_spaces)
 
@@ -61,17 +61,17 @@ def check_if_passed(hf_username):
     Check if given user contributed to hackathon
     :param hf_username: HF Hub username
     """
-    
-    passed = False  
+
+    passed = False
     certificate_type = ""
 
     # If the user contributed to models, datasets and spaces then assign excellence
     if all(get_hub_footprint(hf_username, ORGANIZATION)):
-      passed = True
-      certificate_type = "excellence"
+        passed = True
+        certificate_type = "excellence"
     elif any(get_hub_footprint(hf_username, ORGANIZATION)):
-      passed = True
-      certificate_type = "completion"
+        passed = True
+        certificate_type = "completion"
 
     return passed, certificate_type
 
@@ -90,25 +90,25 @@ def generate_certificate(certificate_template, first_name, last_name, hf_usernam
 
     name_font = ImageFont.truetype("HeiseiMinchoStdW7.otf", 60)
     username_font = ImageFont.truetype("HeiseiMinchoStdW7.otf", 18)
-    
+
     name = str(first_name) + " " + str(last_name)
     print("NAME", name)
-    
+
     # Debug line name
-    #d.line(((0, 419), (1000, 419)), "gray")
-    #d.line(((538, 0), (538, 1400)), "gray")
-    
+    # d.line(((0, 419), (1000, 419)), "gray")
+    # d.line(((538, 0), (538, 1400)), "gray")
+
     # Name
-    d.text((538, 419), name, fill=(87,87,87), anchor="mm", font=name_font)
+    d.text((538, 419), name, fill=(87, 87, 87), anchor="mm", font=name_font)
 
     # Debug line id
-    #d.line(((815, 0), (815, 1400)), "gray")
+    # d.line(((815, 0), (815, 1400)), "gray")
 
     # Date of certification
-    d.text((815, 327), f"HKH23-{hf_username}", fill=(117,117,117), font=username_font)
+    d.text((815, 327), f"HKH23-{hf_username}", fill=(117, 117, 117), font=username_font)
 
-    pdf = im.convert('RGB')
-    pdf.save('certificate.pdf')
+    pdf = im.convert("RGB")
+    pdf.save("certificate.pdf")
 
     return im, "./certificate.pdf"
 
@@ -116,7 +116,14 @@ def generate_certificate(certificate_template, first_name, last_name, hf_usernam
 def create_initial_csv(path):
     """Create an initial CSV file with headers if it doesn't exist."""
     # Define the headers for our CSV file
-    headers = ['hf_username', 'first_name', 'last_name', 'certificate_type', 'datetime', 'pdf_path']
+    headers = [
+        "hf_username",
+        "first_name",
+        "last_name",
+        "certificate_type",
+        "datetime",
+        "pdf_path",
+    ]
     # Create a new DataFrame with no data and these headers
     df = pd.DataFrame(columns=headers)
     # Save the DataFrame to a CSV file
@@ -128,7 +135,12 @@ def add_certified_user(hf_username, first_name, last_name, certificate_type):
     Add the certified user to the dataset and include their certificate PDF.
     """
     print("ADD CERTIFIED USER")
-    repo = Repository(local_dir="data", clone_from=DATASET_REPO_URL, git_user="wseo", git_email="[email protected]")
+    repo = Repository(
+        local_dir="data",
+        clone_from=DATASET_REPO_URL,
+        git_user="wseo",
+        git_email="[email protected]",
+    )
     repo.git_pull()
 
     csv_full_path = os.path.join("data", CERTIFIED_USERS_FILENAME)
@@ -139,7 +151,7 @@ def add_certified_user(hf_username, first_name, last_name, certificate_type):
     history = pd.read_csv(csv_full_path)
 
     # Check if this hf_username is already in our dataset:
-    check = history.loc[history['hf_username'] == hf_username]
+    check = history.loc[history["hf_username"] == hf_username]
     if not check.empty:
         history = history.drop(labels=check.index[0], axis=0)
 
@@ -148,24 +160,26 @@ def add_certified_user(hf_username, first_name, last_name, certificate_type):
     # Copy the PDF from its current location to the target directory in the repository
     pdf_repo_filename = f"{hf_username}.pdf"  # Create a specific name for the PDF file
     pdf_repo_path_full = os.path.join(pdfs_repo_path, pdf_repo_filename)
-    
+
     # Create the pdfs directory if it doesn't exist
     os.makedirs(pdfs_repo_path, exist_ok=True)
-    
-    shutil.copy('./certificate.pdf', pdf_repo_path_full)  # Copy the file
-
-    # Now, add a new entry to your CSV for this user and their PDF
-    new_row = pd.DataFrame({
-        'hf_username': hf_username,
-        'first_name': first_name,
-        'last_name': last_name,
-        'certificate_type': certificate_type,
-        'datetime': time.time(),  # This captures the current time
-        'pdf_path': pdf_repo_path_full[5:]  # This is the relative path to the PDF within the repo
-    }, index=[0])
-    
+
+    shutil.copy("./certificate.pdf", pdf_repo_path_full)  # Copy the file
+
+    new_row = pd.DataFrame(
+        {
+            "hf_username": hf_username,
+            "first_name": first_name,
+            "last_name": last_name,
+            "certificate_type": certificate_type,
+            "datetime": time.time(),  # current time
+            "pdf_path": pdf_repo_path_full[5:],  # relative path to the PDF within the repo
+        },
+        index=[0],
+    )
+
     history = pd.concat([new_row, history[:]]).reset_index(drop=True)
-    
+
     # Save the updated CSV
     history.to_csv(os.path.join("data", CERTIFIED_USERS_FILENAME), index=False)
 
@@ -174,9 +188,9 @@ def add_certified_user(hf_username, first_name, last_name, certificate_type):
     repo.push_to_hub(commit_message="Update certified users list and add PDF")
 
 
-def create_certificate(passed, certificate_type, hf_username, first_name, last_name):  
+def create_certificate(passed, certificate_type, hf_username, first_name, last_name):
     """
-    Generates certificate, adds message, saves username of the certified user 
+    Generates certificate, adds message, saves username of the certified user
     :param passed: boolean whether the user passed enough assignments
     :param certificate_type: type of the certificate - completion or excellence
     :param hf_username: Hugging Face Hub username entered by user
@@ -185,36 +199,41 @@ def create_certificate(passed, certificate_type, hf_username, first_name, last_n
     """
 
     if passed and certificate_type == "excellence":
-        # Generate a certificate of 
-        certificate, pdf = generate_certificate("./certificate-excellence.png", first_name, last_name, hf_username)
+        # Generate a certificate of
+        certificate, pdf = generate_certificate(
+            "./certificate-excellence.png", first_name, last_name, hf_username
+        )
         # Add this user to our database
-        add_certified_user(hf_username, first_name, last_name, certificate_type)    
+        add_certified_user(hf_username, first_name, last_name, certificate_type)
         # Add a message
         message = f"""
-        Congratulations, you successfully completed the 2023 Hackathon 🎉! \n 
-        Since you contributed to models, datasets, and spaces- you get a Certificate of Excellence 🎓. \n
-        You can download your certificate below ⬇️ \n
-        Don't hesitate to share your certificate link below on Twitter and Linkedin (you can tag me @wonhseo, @pseudolab and @huggingface) 🤗
-        https://huggingface.co/datasets/pseudolab/huggingface-krew-hackathon2023/resolve/main/pdfs/{hf_username}.pdf
+        Congratulations, you successfully completed the 2023 Hackathon 🎉! 
+        Since you contributed to models, datasets, and spaces- you get a Certificate of Excellence 🎓.
+        You can download your certificate below ⬇️
+        https://huggingface.co/datasets/pseudolab/huggingface-krew-hackathon2023/resolve/main/pdfs/{hf_username}.pdf\n
+        Don't hesitate to share your certificate link above on Twitter and Linkedin (you can tag me @wonhseo, @pseudolab and @huggingface) 🤗
+        
         """
-    elif passed and certificate_type == "completion":    
+    elif passed and certificate_type == "completion":
         # Generate a certificate of completion
-        certificate, pdf = generate_certificate("./certificate-completion.png", first_name, last_name, hf_username)
+        certificate, pdf = generate_certificate(
+            "./certificate-completion.png", first_name, last_name, hf_username
+        )
         # Add this user to our database
-        add_certified_user(hf_username, first_name, last_name, certificate_type)    
+        add_certified_user(hf_username, first_name, last_name, certificate_type)
         # Add a message
         message = f"""
-        Congratulations, you successfully completed the 2023 Hackathon 🎉! \n 
-        Since you contributed to at least one model, dataset, or space- you get a Certificate of Completion 🎓. \n 
-        You can download your certificate below ⬇️ \n
-        Don't hesitate to share your certificate link below on Twitter and Linkedin (you can tag me @wonhseo, @pseudolab and @huggingface) 🤗 \n
+        Congratulations, you successfully completed the 2023 Hackathon 🎉!
+        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/pdfs/{hf_username}.pdf\n
+        Don't hesitate to share your certificate link above on Twitter and Linkedin (you can tag me @wonhseo, @pseudolab and @huggingface) 🤗 \n
         You can try to get a Certificate of Excellence if you contribute to all types of repos, please don't hesitate to do so.
-        https://huggingface.co/datasets/pseudolab/huggingface-krew-hackathon2023/resolve/main/pdfs/{hf_username}.pdf
         """
     else:
         # Not passed yet
         certificate = Image.new("RGB", (100, 100), (255, 255, 255))
-        pdf = "./fail.pdf"        
+        pdf = "./fail.pdf"
         # Add a message
         message = """
           You didn't pass the minimum of one contribution to get a certificate of completion. 
@@ -225,19 +244,23 @@ def create_certificate(passed, certificate_type, hf_username, first_name, last_n
 
 
 def certification(hf_username, first_name, last_name):
-  passed, certificate_type = check_if_passed(hf_username)
-  certificate, message, pdf = create_certificate(passed, certificate_type, hf_username, first_name, last_name)
-  print("MESSAGE", message)
+    passed, certificate_type = check_if_passed(hf_username)
+    certificate, message, pdf = create_certificate(
+        passed, certificate_type, hf_username, first_name, last_name
+    )
+    print("MESSAGE", message)
+
+    if passed:
+        visible = True
+    else:
+        visible = False
+
+    return message, pdf, certificate, output_row.update(visible=visible)
 
-  if passed:
-    visible = True
-  else:
-    visible = False
-  
-  return message, pdf, certificate, output_row.update(visible=visible) 
 
 with gr.Blocks() as demo:
-    gr.Markdown(f"""
+    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**.
@@ -246,9 +269,12 @@ with gr.Blocks() as demo:
     For more information about the certification process [check the hackathon page on certification](https://pseudo-lab.github.io/huggingface-hackathon23/submit.html#certification).
     
     Don't hesitate to share your certificate on Twitter (tag me [@wonhseo](https://twitter.com/wonhseo), [@pseudolab](https://twitter.com/pseudo-lab), and [@huggingface](https://twitter.com/huggingface)) and on LinkedIn.
-    """)
-    
-    hf_username = gr.Textbox(placeholder="wseo", label="Your Hugging Face Username (case sensitive)")
+    """
+    )
+
+    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")
 
@@ -259,7 +285,11 @@ with gr.Blocks() as demo:
         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])
+    check_progress_button.click(
+        fn=certification,
+        inputs=[hf_username, first_name, last_name],
+        outputs=[output_text, output_pdf, output_img, output_row],
+    )
 
-    
-demo.launch(debug=True)
+
+demo.launch(debug=True)