Update app.py

app.py

@@ -14,6 +14,13 @@ if not cohere_api_key:
 co = cohere.Client(cohere_api_key)
 
 def generate_body(job_description, language):
+    """
+    Generate the body of a job application letter using Cohere's language model.
+    
+    :param job_description: The description of the job you are applying for.
+    :param language: The language in which the letter should be written (English or German).
+    :return: The generated body text for the job application letter.
+    """
     # Set the language model based on user selection
     model = 'command-xlarge-nightly'  # Default to command-xlarge-nightly model for both English and German
 
@@ -30,6 +37,25 @@ def generate_body(job_description, language):
     return response.generations[0].text.strip()
 
 def create_application_letter(name, address, email, phone, job_position, employer_name, greeting_option, employer_contact_name, employer_address, job_id, start_date, job_description, language, output_format):
+    """
+    Create a job application letter with the provided details and format it for download.
+    
+    :param name: Applicant's full name.
+    :param address: Applicant's address.
+    :param email: Applicant's email address.
+    :param phone: Applicant's phone number.
+    :param job_position: Position being applied for.
+    :param employer_name: Employer's name.
+    :param greeting_option: Indicates whether the recipient's name is known.
+    :param employer_contact_name: Employer contact's name (if known).
+    :param employer_address: Employer's address.
+    :param job_id: Job ID for the application.
+    :param start_date: Desired start date for the job.
+    :param job_description: The job description.
+    :param language: Language of the letter (English or German).
+    :param output_format: Desired output format (DOCX or PDF).
+    :return: The filename of the generated application letter.
+    """
     # Generate the body using the job description and language
     body = generate_body(job_description, language)
 
@@ -100,13 +126,28 @@ def create_application_letter(name, address, email, phone, job_position, employe
         return output_filename_docx
 
 def generate_and_download(name, address, email, phone, job_position, employer_name, greeting_option, employer_contact_name, employer_address, job_id, start_date, job_description, language, output_format):
-    # Generate the application letter
+    """
+    Generate the application letter and return the file for download.
+    
+    :return: Filename of the generated application letter for download.
+    """
     output_filename = create_application_letter(name, address, email, phone, job_position, employer_name, greeting_option, employer_contact_name, employer_address, job_id, start_date, job_description, language, output_format)
-    # Return the file for download
     return output_filename
 
 # Define the Gradio interface
 with gr.Blocks() as demo:
+    gr.Markdown("""
+    ## Professional Job Application Letter Generator
+    
+    This tool helps you generate a professional job application letter in either English or German. 
+    The letter is automatically formatted and can be downloaded in DOCX or PDF format.
+    
+    ### Powered by Cohere's Language Model
+    
+    The body of the application letter is generated using **Cohere**, a state-of-the-art language model, 
+    ensuring that your application is not only well-written but also tailored to the job description you provide.
+    """)
+    
     name = gr.Textbox(label="Name", placeholder="Enter your full name", value="Claire Waßer")
     address = gr.Textbox(label="Address", placeholder="Enter your address", value="Musterstraße 78, 23456 Musterstadt")
     email = gr.Textbox(label="Email", placeholder="Enter your email", value="Email@email.de")