resolve conflicts

README.md

@@ -20,6 +20,7 @@ $ pip install -r requirements.txt
 $ -- Run backend
 $ uvicorn app:app --reload # For running the FastAPI server
 $ -- Run frontend
+$ cd frontend
 $ streamlit run app.py # For running the Streamlit App
 ```
 
@@ -30,6 +31,17 @@ $ streamlit run app.py # For running the Streamlit App
 - Now, you can paste your code in the `Code` field and click on the `Generate Documentation` button.
 - The generated documentation will be displayed in the `Documentation` field.
 
+
+## Demo and Screenshots
+##### Demo Screenshot 1
+![Result 3](assets/results3.jpg)
+
+##### Demo Screenshot 2
+![Result 2](assets/results2.jpg)
+
+##### Demo Screenshot 3
+![Result 1](assets/results1.jpg)
+
 ## Tech Stack Used
 ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
 ![Azure](https://img.shields.io/badge/azure_SQL-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)

TechdocsAPI/.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

TechdocsAPI/Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.11
+
+WORKDIR /backend
+
+COPY ./requirements.txt /backend/requirements.txt
+
+RUN pip install --no-cache-dir --upgrade -r /backend/requirements.txt
+
+COPY . .
+
+CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "7860"]

TechdocsAPI/README.md

@@ -0,0 +1,48 @@
+---
+title: TechdocsAPI
+emoji: 🐢
+colorFrom: green
+colorTo: green
+sdk: docker
+pinned: false
+---
+
+# Techdocs: A code documentation generator
+
+## Introduction
+
+**Code Documentation Generation** is a tool that generates documentation for your code. It is a simple tool that can be used by anyone who wants to generate documentation for their code. It leverages the power of **OpenAI GPT-3, Huggingface Transformers, Langchain and Clarifai** to generate documentation for your code. 
+
+To use the application, you need to provide your code as input. The tool will analyze your code and generate documentation for it. The documentation will include comments, descriptions, parameters, return values, examples, and more.
+
+It is a useful tool for developers who want to document their code without spending too much time and effort. It can help you improve the readability, maintainability, and quality of your code. It can also help you share your code with others more easily.
+
+## Installation
+> Download zip or Clone the repository and run the following command in the terminal to install the required packages. 
+
+> We recommend using a virtual environment for the installation. 
+
+```bash
+$ git clone https://github.com/HemanthSai7/Techdocs
+$ cd Techdocs
+$ pip install -r requirements.txt
+$ -- Run backend
+$ uvicorn app:app --reload 
+```
+
+## Tech Stack Used
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+![Azure](https://img.shields.io/badge/azure_SQL-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)
+![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)
+![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)
+![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
+![Streamlit](https://img.shields.io/badge/Streamlit-EA6566?style=for-the-badge&logo=streamlit&logoColor=white)
+![Langchain](https://img.shields.io/badge/Langchain-F70A8D?style=for-the-badge&logo=langchain&logoColor=white)
+![Clarifai](https://img.shields.io/badge/Clarifai-FFA500?style=for-the-badge&logo=clarifai&logoColor=white)
+
+## Team Members
+| Name | Github |
+| --- | --- |
+| Mayuresh Agashe | [Mayuresh Agashe](https://github.com/mayureshagashe2105) |
+| Hemanth Sai Garladinne | [Hemanth Sai Garladinne](https://github.com/HemanthSai7) |

{backend → TechdocsAPI/backend}/__init__.py

@@ -7,7 +7,7 @@ from fastapi.exceptions import HTTPException
 from backend.utils import DBConnection
 from backend.core.ConfigEnv import config
 
-from langchain.llms import CTransformers, Clarifai
+from langchain.llms import Clarifai
 from langchain.chains import LLMChain
 from langchain.prompts import PromptTemplate 
 
@@ -40,9 +40,9 @@ try:
         prompt=prompt,
         llm=llm
     )
-
     app.state.llmchain = llmchain
 
+
 except mysql.connector.Error as err:
     raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(err))    
 

{backend → TechdocsAPI/backend}/requirements.txt

@@ -1,5 +1,7 @@
-fastapi
+fastapi==0.99.1
+uvicorn
 requests
+pydantic==1.10.12
 python-jose[cryptography]
 passlib[bcrypt]
 mysql-connector-python

{backend → TechdocsAPI/backend}/router.py

@@ -64,7 +64,5 @@ async def regenerate_api_key(access_token: str = Depends(JWTBearer())):
 async def inference(code_block:str, api_key: str,access_token:str=Depends(JWTBearer())):
     print("inference")
     user_sub=Auth.get_user_credentials(access_token)
-
-    print("after res")
     
     return ops_inference(code_block,api_key,user_sub)

{backend → TechdocsAPI/backend}/services/auth/ops.py

@@ -1,6 +1,5 @@
 from .utils.auth_funcs import *
 from .utils.JWTBearer import *
-from backend.services import parser
 from backend.models import *
 from backend.services.db.utils.DBQueries import DBQueries
 from backend.core.Exceptions import *
@@ -103,6 +102,7 @@ def ops_inference(source_code:str,api_key:str,username:str):
         llm_response = app.state.llmchain.run({"instruction": source_code_message})
 
         docstring = Inference(docstr=llm_response)
+        print(docstring)
         
     
         return docstring

TechdocsAPI/backend/utils/__init__.py

@@ -0,0 +1 @@
+from .DBConnection import DBConnection

backend/vercel.json

@@ -1,4 +0,0 @@
-{
-  "builds": [{ "src": "__init__.py", "use": "@vercel/python" }],
-  "routes": [{ "src": "/(.*)", "dest": "__init__.py" }]
-}

frontend/Login.py

@@ -6,34 +6,14 @@ import streamlit as st
 
 def auth_page():
 
-    base_url = 'http://127.0.0.1:8000'
+    base_url = 'http://localhost:8000'
 
 
     headers={"accept":"application/json"}
 
-    tab1, tab2 = st.tabs(["Signup", "Login"])
+    tab1, tab2 = st.tabs(["Login", "Signup"])
 
     with tab1:
-        with st.form(key="myform1"):
-            username = st.text_input(label="Username", label_visibility="collapsed", placeholder="Username")
-            password = st.text_input(label="Password", label_visibility="collapsed", placeholder="Password", type="password")
-            email = st.text_input(label="Email", label_visibility="collapsed", placeholder="Email")
-            signup_button = st.form_submit_button(label="Signup")
-
-        with st.spinner("Signing up..."):
-            if signup_button:
-                try:
-                    credentials = {"username":username, "password":password, "email":email}
-                    response = requests.post(url=base_url + "/auth/signup", headers=headers, data=json.dumps(credentials))
-                    if (response.status_code!=200):
-                        raise Exception("Signup Failed")
-                
-                    st.success("Signed up successfully")
-                except:
-                    st.error("Signup Failed")       
-            
-
-    with tab2:
         with st.form(key="myform2"):
             username = st.text_input(label="Username", label_visibility="collapsed", placeholder="Username")
             password = st.text_input(label="Password", label_visibility="collapsed", placeholder="Password", type="password")
@@ -56,4 +36,25 @@ def auth_page():
                 except Exception as e:
                     st.error(e)
 
+    with tab2:
+        with st.form(key="myform1"):
+            username = st.text_input(label="Username", label_visibility="collapsed", placeholder="Username")
+            password = st.text_input(label="Password", label_visibility="collapsed", placeholder="Password", type="password")
+            email = st.text_input(label="Email", label_visibility="collapsed", placeholder="Email")
+            signup_button = st.form_submit_button(label="Signup")
+
+        with st.spinner("Signing up..."):
+            if signup_button:
+                try:
+                    credentials = {"username":username, "password":password, "email":email}
+                    response = requests.post(url=base_url + "/auth/signup", headers=headers, data=json.dumps(credentials))
+                    if (response.status_code!=200):
+                        raise Exception("Signup Failed")
+                
+                    st.success("Signed up successfully")
+                except:
+                    st.error("Signup Failed")       
+            
+
+
 

frontend/__init__.py

@@ -1 +0,0 @@
-    

frontend/pages/Code.py

@@ -4,8 +4,6 @@ from PIL import Image
 
 import streamlit as st
 from Login import auth_page
-# frontend.Login import auth_pageom from streamlit_extras import 
-
 
 st.set_page_config(
     page_title="Welcome",
@@ -14,7 +12,7 @@ st.set_page_config(
     initial_sidebar_state="expanded",
 )
 
-st.write("# DocGup-tea: AI based Documentation Generator 💀")
+st.write("# Welcome to Techdocs: Where Code Meets Clarity! 🚀")
 
 def logout():
     del st.session_state["access_token"]
@@ -58,20 +56,18 @@ def code_page():
     
     headers={"accept":"application/json"}
 
-
+    st.subheader("Enter your API key to generate documentation.")
     API_KEY = st.text_input(label="Enter your API key", label_visibility="hidden",placeholder="Enter your API key", type="password")
-    st.title("Code Documentation Generator")
-    st.write("Enter your code and click 'Generate Comment' to get the corresponding comment.")
+    st.subheader("Enter your code and click 'Generate Documentation' to get the corresponding comment.")
 
-    code_input = st.text_area("Code Input", height=200)
+    code_input = st.text_area("Code Input", height=300)
     comment_placeholder = st.empty()
 
-    if st.button("Generate Comment"):
+    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':"def add(a,b):\n\treturn a+b", 'api_key':API_KEY})
+            response = query_post(base_url + '/api/inference', headers=headers, params={'code_block':code_input, 'api_key':API_KEY})
             docstr = response.json()["docstr"]
-            print(docstr)
             comment_placeholder.subheader("Generated Comment:")
             comment_placeholder.markdown(f"<pre><code>{docstr}</code></pre>", unsafe_allow_html=True)
             # Scroll to the comment section

frontend/requirements.txt

@@ -0,0 +1 @@
+streamlit

frontend/{🏡 Home.py → 🏡_Home.py}

@@ -1,12 +1,13 @@
 import streamlit as st
 from Login import auth_page
 from PIL import Image 
+import textwrap
 
 import base64
 
 # image2=Image.open('assets/logo2.png')
 st.set_page_config(
-    page_title="DocGup-tea",
+    page_title="Techdocs",
     layout="wide",
     page_icon="🏡",
     initial_sidebar_state="expanded",
@@ -18,11 +19,7 @@ def get_base64_bin_file(bin_file):
         data = f.read()
     return base64.b64encode(data).decode()
 
-
-# image = Image.open('assets/poster.jpg')
-# st.image(image, caption='ELIGILOAN')
-
-st.markdown("# :DocGup-tea: AI based Documentation Generator 📃")
+st.markdown("# Welcome to Techdocs: Where Code Meets Clarity! 🚀")
 
 def logout():
     del st.session_state["access_token"]
@@ -56,29 +53,33 @@ def home_page():
         '''
         st.markdown(page_bg_img, unsafe_allow_html=True)
 
-    set_page_background("../assets/bg.jpg") 
+    # set_page_background("../assets/bg.jpg") 
 
     st.markdown(
         """
 
-        ## A step-by-step guide 
+    ##### 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.
+
+    ## 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! 🌟
+
+
 
-        The process is quite straightforward. BOB offers loans to eligible applicants with strong financial profiles. 
-        Individuals need to provide their basic personal, employment, income and property details to know if you are fit to apply for a loan.
 
-        ### 1 . Login 
 
-        Step one is the login part, you just have to work your way through the following simple steps.
-        - Enter your mobile number
-        - Enter the OTP recieved 
-        - accept consent in the Safe portal
 
-        ### 2. Loan page
 
-        Once you login, you will be redirected to the loan page.
-        - Offer all relevant details such as loan amount, loan history, income, etc.
-        - Click on the submit option once you have filled in all the details.
-        - Our algorithm will assess your eligibility based on the details provided by you and you will be awarded with a `yes` or a `no`.
     """
     )
 

techdocs/execute.py

@@ -0,0 +1,28 @@
+from utils import parse,functools
+
+import argparse
+
+def main():
+    parser = argparse.ArgumentParser(description='Weather Application')
+    parser.add_argument('--api_key','-k',help='API key for Techdocs')
+    parser.add_argument('--username','-u',help='Username for Techdocs')
+    parser.add_argument('--password','-p',help='Password for Techdocs')
+    parser.add_argument('--dir','-d',help='Root directory to be documented')
+
+    args=parser.parse_args()
+
+    config = {
+        arg[0]:arg[1] for arg in args._get_kwargs()
+    }
+
+    data = {
+            "username":config['username'],
+            "password":config['password']
+            }
+
+    config.update({"access_token":functools.get_access_token(data)})
+
+    parse.extract_functions_from_directory(config)
+    
+if __name__ == '__main__':
+    main()    

techdocs/requirements.txt

@@ -0,0 +1 @@
+tqdm

techdocs/utils/functools.py

@@ -0,0 +1,43 @@
+import json
+import requests
+
+BASE_URL = "http://localhost:8000"
+
+
+
+def get_access_token(data, return_refresh_token=False):
+    url = BASE_URL + "/auth/login"
+    headers = {
+        "accept": "application/json",
+    }
+    data = json.dumps(data)
+    response = requests.post(url, data=data, headers=headers)
+    access_token = response.json()['access_token']
+    if return_refresh_token:
+        refresh_token = response.json()['refresh_token']
+        return access_token, refresh_token
+    return access_token
+
+
+
+
+def request_inference(config, code_block, max_retries=1):
+
+    if max_retries == 0:
+        return ""
+
+    url = BASE_URL+"/api/inference"
+    headers={"accept":"application/json", "Authorization": f"Bearer {config['access_token']}"}
+    code_input = code_block
+    response = requests.post(url=url, headers=headers, params={'code_block':code_input, 'api_key':config['api_key']})
+    if response.status_code == 200:
+        return response.json()["docstr"]
+    else:
+        data = {
+            "username":config['username'],
+            "password":config['password']
+        }
+        print("Encountered error retrying...")
+        config.update({"access_token":get_access_token(data)})
+        
+        return request_inference(config,config["access_token"], code_block, max_retries=max_retries-1)

techdocs/utils/parse.py

@@ -0,0 +1,35 @@
+import ast
+import os
+from tqdm import tqdm
+import requests
+
+from utils.functools import *
+
+
+# Function to extract and print the outermost nested function with line number
+def extract_outermost_function(node,  config, line_number=1,):
+    base_url = "http://localhost:8000"
+    if isinstance(node, ast.FunctionDef):
+        function_def = ast.unparse(node)
+        print(f"Function starting at line {line_number}:\n{function_def}")
+        print("=" * 30)
+
+        response = request_inference(config=config,code_block=function_def)
+        
+
+    for child in ast.iter_child_nodes(node):
+        if isinstance(child, ast.FunctionDef):
+            line_number = child.lineno
+        extract_outermost_function(child, line_number)
+
+# Function to traverse directories recursively and extract functions from Python files
+def extract_functions_from_directory(config):
+    for root, _, files in os.walk(config["dir"]):
+        for file in files:
+            if file.endswith(".py"):
+                file_path = os.path.join(root, file)
+                print(file_path)
+                with open(file_path, "r",errors='ignore') as file:
+                    content = file.read()
+                parsed = ast.parse(content)
+                extract_outermost_function(parsed, config)