Frontend complete

frontend/.streamlit/config.toml

@@ -0,0 +1,7 @@
+[theme]
+
+primaryColor="#818cf8"
+backgroundColor="#FFFFFF"
+secondaryBackgroundColor="#F0F2F6"
+textColor="#262730"
+font="sans serif"

frontend/Login.py

@@ -31,7 +31,7 @@ def auth_page():
                     st.session_state["access_token"] = response.json()['access_token']
                     st.session_state["refresh_token"] = response.json()['refresh_token']
                     st.success("Logged in successfully")
-                    st.experimental_rerun()
+                    st.rerun()
 
                 except Exception as e:
                     st.error(e)

frontend/pages/Code.py

@@ -10,41 +10,65 @@ st.set_page_config(
     page_icon="👋",
     layout="wide",
     initial_sidebar_state="expanded",
+    menu_items={"About": "Built by @HemanthSai7 and @MayureshAgashe2107 with Streamlit"},
 )
 
-st.write("# Welcome to Techdocs: Where Code Meets Clarity! 🚀")
+st.markdown("## :rainbow[Welcome to Techdocs: Where Code Meets Clarity!] 🚀")
+
+
 
 def logout():
     del st.session_state["access_token"]
     del st.session_state["refresh_token"]
     del st.session_state["username"]
 
+def instructions():
+    with st.expander("📝Instructions",expanded=True):
+        st.markdown(
+            """
+            ##### 1. Generate an `API Key` from the sidebar to get started.
+
+            ##### 2. Paste the  `API Key` in the field provided.
+
+            ##### 3. Paste your code function in the input code box.
+
+            ##### 4. Click on the `Generate Documentation` 🤖 button to generate the documentation.
+            
+            ##### 5. The generated documentation will be displayed in the section below.
+
+            """
+        ) 
+
+
 with st.sidebar:
     if 'username' not in st.session_state:
-        st.header("Login/Signup")
+        with st.expander("🧑Account Details",expanded=True):
+            st.header("Please Login or Signup to continue")
     else:
-        st.header(f"Welcome, {st.session_state.username}!")
-        st.warning("Generating a new API Key will invalidate the previous one from all your projects. Do you wish to continue?")
-        if st.button("Generate API KEY"):
-            with st.spinner("Generating API Key..."):
-                try:
-                    base_url = "http://localhost:8000"
-                    headers={"accept":"application/json", "Authorization": f"Bearer {st.session_state.access_token}"}
-                    response = requests.put(url=base_url + "/auth/regenerate_api_key", headers=headers, data=json.dumps({"username":st.session_state.username}))
-                    if (response.status_code!=200):
-                        raise Exception("API Key Generation Failed")
-                    st.info("Please save the API KEY as it will be shown only once.")
-                    st.code(response.json()["api_key"],"bash")
-                    st.success("API Key Generated Successfully")
-                except Exception as e:
-                    st.error(e)
+        
+        with st.expander("🔑 TECHDOCS-API-KEY",expanded=True):
+            st.warning("Generating a new API Key will invalidate the previous one from all your projects. Do you wish to continue?")
+            if st.button("Generate API KEY"):
+                with st.spinner("Generating API Key..."):
+                    try:
+                        base_url = "http://localhost:8000"
+                        headers={"accept":"application/json", "Authorization": f"Bearer {st.session_state.access_token}"}
+                        response = requests.put(url=base_url + "/auth/regenerate_api_key", headers=headers, data=json.dumps({"username":st.session_state.username}))
+                        if (response.status_code!=200):
+                            raise Exception("API Key Generation Failed")
+                        st.info("Please save the API KEY as it will be shown only once.")
+                        st.code(response.json()["api_key"],"bash")
+                        st.success("API Key Generated Successfully")
+                    except Exception as e:
+                        st.error(e)
         
 
 
-        with st.expander("More Options"):
-            if st.button("Logout"):
+        with st.expander("🧑Account Details",expanded=True):
+            st.info(f"Welcome, {st.session_state.username}! 😄")
+            if st.button("Logout 👋"):
                 logout()
-                st.experimental_rerun()
+                st.rerun()
 
 
 def code_page():
@@ -56,19 +80,20 @@ def code_page():
     
     headers={"accept":"application/json"}
 
-    st.subheader("Enter your API key to generate documentation.")
+    instructions()
+    st.warning("Hi there! Paste your TECHDOCS-API-KEY in the field below to get started!\n\n", icon="🚨")
     API_KEY = st.text_input(label="Enter your API key", label_visibility="hidden",placeholder="Enter your API key", type="password")
-    st.subheader("Enter your code and click 'Generate Documentation' to get the corresponding comment.")
+  
 
-    code_input = st.text_area("Code Input", height=300)
+    code_input = st.text_area("Code Input", height=300, help="Paste your code here")
     comment_placeholder = st.empty()
 
-    if st.button("Generate Documentation"):
+    if st.button("🤖 Generate Documentation"):
         if code_input:
             headers['Authorization'] = f"Bearer {st.session_state.access_token}"
             response = query_post(base_url + '/api/inference', headers=headers, params={'code_block':code_input, 'api_key':API_KEY})
             docstr = response.json()["docstr"]
-            comment_placeholder.subheader("Generated Comment:")
+            comment_placeholder.subheader("Generated Documentation:")
             comment_placeholder.markdown(f"<pre><code>{docstr}</code></pre>", unsafe_allow_html=True)
             # Scroll to the comment section
             comment_placeholder.empty()

frontend/pages/Usage.py

@@ -0,0 +1,91 @@
+import streamlit as st
+from Login import auth_page
+
+st.set_page_config(
+    page_title="Usage",
+    layout="wide",
+    page_icon="📝",
+    initial_sidebar_state="expanded",
+)
+
+st.markdown("## :rainbow[Welcome to Techdocs: Where Code Meets Clarity!]🚀")
+
+def logout():
+    del st.session_state["access_token"]
+    del st.session_state["refresh_token"]
+    del st.session_state["username"]
+
+with st.sidebar.expander("🧑Account Details",expanded=True):
+    if 'username' not in st.session_state:
+        st.warning("Please Login or Signup to continue")
+    else:
+        st.info(f"Welcome, {st.session_state.username}! 😄")
+        if st.button("Logout 👋"):
+            logout()
+            st.rerun()
+
+def usage():
+    st.markdown("### :rainbow[How to use Techdocs?]")
+
+    col1,col2 = st.columns(2,gap="small")
+
+    with col1:
+
+        st.image("../assets/image.png",width=300,use_column_width=True)
+
+        st.caption("Boat sailing in the sea")
+
+    with col2:
+        intro_text="""
+        Now that you've arrived at this digital crossroads, you're most likely eager to dive into the world of Techdocs. Great choice! In today's fast-paced tech landscape, having well-structured and easily accessible documentation is like having a treasure map to navigate the vast ocean of code. You are probably wondering how to use Techdocs.  
+        """
+
+        text="""
+        But you might be wondering: "How do I embark on this documentation journey with Techdocs?" Fear not, because we're about to chart a course through the fascinating world of Techdocs, where clarity, efficiency, and ease-of-use are the guiding stars.
+        """
+        st.write(f'<p style="font-size:20px; color:#9c9d9f ">{intro_text}</p>', unsafe_allow_html=True)
+        st.write(f'<p style="color:#9c9d9f; font-size:20px">{text}</p>', unsafe_allow_html=True)
+
+    st.markdown("### 📝 Using Techdocs via the CLI")    
+
+    with st.expander("⚙️ Installation and setup",expanded=True):
+        st.text("1. Create a virtual environment. We recommend using conda but you can python's venv as well:"); st.code("conda create -n techdocs python=3.11","python")
+        st.text("2. Install Techdocs via pip:"); st.code("pip install techdocs","python")
+        st.text("3. CD into your project directory.")
+        st.code("CD <YOUR-PROJECT-DIRECTORY>","bash")
+        st.text("""
+                4. Login into our Techdocs Streamlit app or signup if you don't have an account.
+
+                5. Generate an API Key from the Techdocs Streamlit app and paste it in the command below.
+                """)
+        st.code("techdocs -k <API_KEY> -u <USERNAME> -p <PASSWORD> -d <ROOT-DIRECTORY-OF-THE -PROJECT","bash")
+        st.text("6. Wait for the documentation to be generated. You can view the status of the documentation generation in the CLI.")
+
+    st.divider()
+    st.markdown("### 📝 Using Techdocs via the Streamlit")
+
+    with st.expander("📝Instructions",expanded=True):
+        st.markdown(
+            """
+            ##### 1. Head over to the Code Page.
+
+            ##### 2. Generate an `API Key` from the sidebar to get started.
+
+            ##### 3. Paste the `API Key` in the field provided.
+
+            ##### 4. Paste your code function in the input code box.
+
+            ##### 5. Click on the `Generate Documentation`🤖 button to generate the documentation.
+            
+            ##### 6. The generated documentation will be displayed in the section below.
+
+            """
+        )      
+
+
+
+if 'access_token' not in st.session_state:
+    st.session_state.runpage = auth_page
+else:
+    st.session_state.runpage = usage
+st.session_state.runpage()                

frontend/🏡_Home.py

@@ -19,21 +19,21 @@ def get_base64_bin_file(bin_file):
         data = f.read()
     return base64.b64encode(data).decode()
 
-st.markdown("# Welcome to Techdocs: Where Code Meets Clarity! 🚀")
+st.markdown("## :rainbow[Welcome to Techdocs: Where Code Meets Clarity!]🚀")
 
 def logout():
     del st.session_state["access_token"]
     del st.session_state["refresh_token"]
     del st.session_state["username"]
 
-with st.sidebar:
+with st.sidebar.expander("🧑Account Details",expanded=True):
     if 'username' not in st.session_state:
-        st.header("Login/Signup")
+        st.warning("Please Login or Signup to continue")
     else:
-        st.header(f"Welcome, {st.session_state.username}!")
-        if st.button("Logout"):
+        st.info(f"Welcome, {st.session_state.username}! 😄")
+        if st.button("Logout 👋"):
             logout()
-            st.experimental_rerun()
+            st.rerun()
 
 
 def home_page():
@@ -58,31 +58,49 @@ def home_page():
     st.markdown(
         """
 
-    ##### Unleash the documentation dynamo that is **Techdocs**! Say goodbye to the documentation drudgery that haunts coders' dreams and embrace the effortless power of AI-driven documentation. With **Techdocs**, harness the genius of OpenAI's GPT-3, the magic of WizardCoderLM, the versatility of Huggingface Transformers, and the precision of Langchain and Clarifai.
+    ##### Unleash the documentation dynamo that is **Techdocs**! Say goodbye to the documentation drudgery that haunts coders' dreams and embrace the effortless power of AI-driven documentation. With **Techdocs**, harness the genius of LLama2, the magic of WizardCoderLM, the versatility of Huggingface Transformers, and the precision of Langchain and Clarifai.
 
-    ## How Does Techdocs Work Its Magic? 🔮
+    ## :rainbow[How Does Techdocs Work Its Magic?] 🔮
 
     ##### Just feed your code into **Techdocs**, and like a seasoned wizard, it'll conjure up beautifully detailed documentation in an instant. Your code will transform into a masterpiece of clarity, complete with insightful comments, vivid descriptions, crystal-clear parameters, return values, and real-world examples.
 
-    ## What Can Techdocs Do for You? 🌟
-
-    - ##### Boost your code quality effortlessly.
-    - ##### Share your brilliance with the world in a snap.
-    - ##### Effortlessly generate documentation for your code.
-    - ##### Include comments, descriptions, parameters, return values, and real-life examples.
-    - ##### Elevate your code's readability, maintainability, and quality.
-
-    ##### **Techdocs** is your code's trusty companion, helping you document with ease so you can focus on what you do best: coding!. **Techdocs** is your secret weapon for leveling up your code game. Whether you're a seasoned developer or just starting your coding journey, Techdocs has got your back. Get ready to unlock the future of code documentation today! 🌟
-
-
+    """
+    )
 
+    with st.expander("What Can Techdocs Do for You? 🌟",expanded=True):
+        st.markdown(
+            """
+        - ##### Boost your code quality effortlessly 🚀.
+        - ##### Share your brilliance with the world in a snap 🌏.
+        - ##### Effortlessly generate documentation for your code 🤖.
+        - ##### Include comments, descriptions, parameters, return values, and real-life examples 📃.
+        - ##### Elevate your code's readability, maintainability, and quality 📃.
+        """
+        )
 
+    st.markdown(
+        """
+        ##### **Techdocs** is your code's trusty companion, helping you document with ease so you can focus on what you do best: coding!. **Techdocs** is your secret weapon for leveling up your code game. Whether you're a seasoned developer or just starting your coding journey, Techdocs has got your back. Get ready to unlock the future of code documentation today! 🌟
+        """
+    )
 
+    st.markdown("""
+                ## :rainbow[How to use Techdocs?]
+                ##### Head over to the **Usage** page to get started!😄
+                """)
+    st.link_button("Usage", "http://localhost:8501/Usage_📝?page=Usage")
 
+    st.sidebar.divider()
+    st.sidebar.info(
+        """
+        Follow us on:
 
-    """
+        Github → [@MayureshAgashe2105](https://github.com/MayureshAgashe2105)\n
+        Github → [@HemanthSai7](https://github.com/HemanthSai7)
+        """
     )
 
+
 if 'access_token' not in st.session_state:
     st.session_state.runpage = auth_page
 else:

testing/DBQueries.py

@@ -9,18 +9,6 @@ class DBQueries:
 
     @classmethod
     def insert_to_database(cls, table_name: str, data: Union[Tuple, List[Tuple]], cols: List[str]=None):
-        """
-    This method is used to insert data into a specified table in the database.
-
-    Args:
-    table_name (str): The name of the table where the data will be inserted.
-    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. It can be either a tuple or a list of tuples.
-    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are required. Defaults to None.
-
-    Raises:
-    TypeError: If the data is not a tuple or a list of tuples.
-    """
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table where the data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. It can be either a tuple or a list of tuples.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are required. Defaults to None.\n\n    Raises:\n    TypeError: If the data is not a tuple or a list of tuples.\n    '
         con = DBConnection.get_client()
         cursor = con.cursor()
         QUERY = f"INSERT INTO {{table_name}} ({','.join(cols)}) VALUES ".format(table_name=table_name)
@@ -35,23 +23,6 @@ class DBQueries:
 
     @classmethod
     def fetch_data_from_database(cls, table_name: str, cols_to_fetch: Union[str, List[str]], where_clause: str=None):
-        """
-    This method is a class method that fetches data from a specified table in the database based on the specified
-    column names and an optional WHERE clause.
-
-    Args:
-    - table_name (str): The name of the table from which to fetch data.
-    - cols_to_fetch (Union[str, List[str]]): The column(s) to fetch from the table. If a single string, it should
-      be a comma-separated list of column names.
-    - where_clause (str, optional): An optional WHERE clause to filter the fetched data. Defaults to None.
-
-    Returns:
-    - List[tuple]: A list of tuples, where each tuple represents a row of data fetched from the database.
-
-    Raises:
-    - None
-    """
-        '\n    This method is a class method that fetches data from a specified table in the database based on the specified\n    column names and an optional WHERE clause.\n\n    Args:\n    - table_name (str): The name of the table from which to fetch data.\n    - cols_to_fetch (Union[str, List[str]]): The column(s) to fetch from the table. If a single string, it should\n      be a comma-separated list of column names.\n    - where_clause (str, optional): An optional WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - List[tuple]: A list of tuples, where each tuple represents a row of data fetched from the database.\n\n    Raises:\n    - None\n    '
         con = DBConnection.get_client()
         cursor = con.cursor()
         if isinstance(cols_to_fetch, str):
@@ -65,21 +36,6 @@ class DBQueries:
 
     @classmethod
     def update_data_in_database(cls, table_name: str, cols_to_update: Union[str, List[str]], where_clause: str=None, new_values: Union[str, List[str]]=None):
-        """
-    This function is used to update data in a specific table in the database.
-
-    Args:
-        table_name (str): The name of the table in which the data needs to be updated.
-        cols_to_update (Union[str, List[str]]): The column(s) that need to be updated. If a single string, it should end with '=%s'. If a list, elements should be separated by '=%s, '.join(cols_to_update).
-        where_clause (str, optional): The WHERE clause to specify the condition for updating the data. Defaults to None.
-        new_values (Union[str, List[str]], optional): The new values that need to be updated in the specified columns. If a single string, it should be a list of new values. Defaults to None.
-
-    Returns:
-        bool: Returns True if the data is successfully updated in the database.
-
-    Raises:
-        None
-    """
         con = DBConnection.get_client()
         cursor = con.cursor()
         if isinstance(cols_to_update, str):

testing/test.py

@@ -1,105 +1,18 @@
 def add(a, b):
-    """
-    This function adds two numbers.
-
-    Arguments:
-    a (int): The first number to be added.
-    b (int): The second number to be added.
-
-    Returns:
-    int: Returns the sum of the two numbers.
-
-    Raises:
-    TypeError: If the input is not an integer.
-    """
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: Returns the sum of the two numbers.\n\n    Raises:\n    TypeError: If the input is not an integer.\n    '
     return a + b
 
 def multiply(a, b):
-    """
-    This function multiplies two given numbers.
-
-    Arguments:
-    a (int or float): The first number to be multiplied.
-    b (int or float): The second number to be multiplied.
-
-    Returns:
-    int or float: The product of the two numbers.
-
-    Raises:
-    TypeError: If the input types are not numbers (int or float).
-
-    """
-    '\n    This function multiplies two given numbers.\n\n    Arguments:\n    a (int or float): The first number to be multiplied.\n    b (int or float): The second number to be multiplied.\n\n    Returns:\n    int or float: The product of the two numbers.\n\n    Raises:\n    TypeError: If the input types are not numbers (int or float).\n\n    '
     return a * b
 
 def subtract(a, b):
-    """
-    This function subtracts the second number from the first number.
-
-    Args:
-    a (int): The first number to be subtracted.
-    b (int): The second number to be subtracted from the first number.
-
-    Returns:
-    int: Returns the result of the subtraction.
-
-    Raises:
-    TypeError: If the input arguments are not integers.
-    """
-    '\n    This function subtracts the second number from the first number.\n\n    Args:\n    a (int): The first number to be subtracted.\n    b (int): The second number to be subtracted from the first number.\n\n    Returns:\n    int: Returns the result of the subtraction.\n\n    Raises:\n    TypeError: If the input arguments are not integers.\n    '
     return a - b
 
 def divide(a, b):
-    """
-    This function divides the first argument by the second argument.
-
-    Arguments:
-    a (float): First argument to be divided.
-    b (float): Second argument by which the first argument is to be divided.
-
-    Returns:
-    float: Returns the result of the division of the first argument by the second argument.
-
-    Raises:
-    ValueError: If the second argument is zero, it raises a ValueError with the message 'Cannot divide by zero'.
-    """
-    "\n    This function divides the first argument by the second argument.\n\n    Arguments:\n    a -- First argument to be divided. It should be a float.\n    b -- Second argument by which the first argument is to be divided. It should be a float.\n\n    Returns:\n    float -- Returns the result of the division of the first argument by the second argument.\n\n    Raises:\n    ValueError -- If the second argument is zero, it raises a ValueError with the message 'Cannot divide by zero'.\n    "
     if b == 0:
         raise ValueError('Cannot divide by zero')
     return a / b
 
 def func(*args, **kwargs):
-    """
-    This function is a decorator that wraps another function and returns a new function that acts as a wrapper.
-
-    Arguments:
-    func (function): The function to be wrapped.
-    * args (tuple): Positional arguments to be passed to the wrapped function.
-    * kwargs (dict): Keyword arguments to be passed to the wrapped function.
-
-    Returns:
-    A new function that acts as a wrapper for the original function.
-
-    Raises:
-    None
-"""
-    '\nThis function is a decorator that wraps another function and returns a new function that acts as a wrapper.\n\nArgs:\n    func (function): The function to be wrapped.\n\nKwargs:\n    Any additional keyword arguments are passed to the wrapped function.\n\nReturns:\n    A new function that acts as a wrapper for the original function.\n\nRaises:\n    None\n'
-
     def wrapper(*args, **kwargs):
-        """
-    This function performs a specific operation on a list of integers.
-
-    Arguments:
-    n (int): The size of the list.
-    k (int): The value to be searched in the list.
-
-    Returns:
-    A list of integers representing the result of the operation.
-
-    Raises:
-    ValueError: If the input arguments are not integers.
-    """
-        "\n    This function is a wrapper that calls another function (specified by 'func') with the given arguments.\n\n    Arguments:\n    * args (tuple): Positional arguments to be passed to 'func'.\n    * kwargs (dict): Keyword arguments to be passed to 'func'.\n\n    Returns:\n    Whatever 'func' returns.\n\n    Raises:\n    Whatever exceptions 'func' raises.\n    "
         return func(*args, **kwargs)
     return wrapper