Fixed spinner adn updated instructions

README.md

@@ -46,13 +46,13 @@ $ streamlit run app.py # For running the Streamlit App
 
 ## Demo and Screenshots
 ##### Demo Screenshot 1
-![Result 3](assets/results3.jpg)
+![Result 1](assets/results1.png)
 
 ##### Demo Screenshot 2
-![Result 2](assets/results2.jpg)
+![Result 2](assets/results2.png)
 
 ##### Demo Screenshot 3
-![Result 1](assets/results1.jpg)
+![Result 3](assets/results3.png)
 
 ## Tech Stack Used
 ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

frontend/.streamlit/config.toml

@@ -1,5 +1,4 @@
 [theme]
-
 primaryColor="#818cf8"
 backgroundColor="#FFFFFF"
 secondaryBackgroundColor="#F0F2F6"

frontend/pages/Code.py

@@ -1,6 +1,5 @@
 import json
 import requests
-from PIL import Image
 
 import streamlit as st
 from Login import auth_page
@@ -10,7 +9,6 @@ st.set_page_config(
     page_icon="👨‍💻",
     layout="wide",
     initial_sidebar_state="expanded",
-    menu_items={"About": "Built by @HemanthSai7 and @MayureshAgashe2107 with Streamlit"},
 )
 
 st.markdown("## :rainbow[Welcome to Techdocs: Where Code Meets Clarity!] 🚀")
@@ -90,18 +88,19 @@ def code_page():
     comment_placeholder = st.empty()
 
     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, 
-                                  data=json.dumps({'code_block':code_input, 'api_key':API_KEY}))
-            docstr = response.json()["docstr"]
-            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()
-            comment_placeholder.markdown(f"<pre><code>{docstr}</code></pre>", unsafe_allow_html=True)
-        else:
-            st.warning("Please enter some code.")
+        with st.spinner("Generating Documentation..."):
+            if code_input:
+                headers['Authorization'] = f"Bearer {st.session_state.access_token}"
+                response = query_post(base_url + '/api/inference', headers=headers, 
+                                    data=json.dumps({'code_block':code_input, 'api_key':API_KEY}))
+                docstr = response.json()["docstr"]
+                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()
+                comment_placeholder.markdown(f"<pre><code>{docstr}</code></pre>", unsafe_allow_html=True)
+            else:
+                st.warning("Please enter some code.")
 
 st.sidebar.divider()
 st.sidebar.info(

frontend/pages/Usage.py

@@ -50,17 +50,21 @@ def usage():
 
     st.markdown("### 📝 :rainbow[Using Techdocs via the CLI]")  
     st.info("Please use the CLI to generate the documentation for your project. The Streamlit app is just a preview to give the user an idea of the project.")  
-    st.warning("The API Key can only be generated from the Techdocs Streamlit app. To start using the CLI, please generate an API Key from the Streamlit app.")
+    st.warning("To start using the CLI, please generate an API Key from the Streamlit app. You can also generate the API Key from 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.write("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.write("2. Install Techdocs via pip:"); st.code("pip install techdocs","python")
+        st.write("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.")
-        st.text("5. Generate an API Key from the Code page 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.")   
+
+    with st.expander("🚀 CLI and Working", expanded=True):
+        st.write("1. Once the installation is complete, type **techdocs** in the terminal. You should be able to see info about our CLI.")
+        st.write("2. You can login into our Techdocs app using the CLI or create an account if you don't have one. To signup, type the following command in the terminal:")
+        st.code("techdocs signup -u <username> -p <password> -e <email>", "bash")
+        st.write("3. Generate an API Key from the Code page and paste it in the command below.")
+        st.code("techdocs generate -k <API_KEY> -u <USERNAME> -p <PASSWORD> -d <ROOT-DIRECTORY-OF-THE-PROJECT>","bash")
+        st.write("4. Wait for the documentation to be generated. You can view the status of the documentation generation in the CLI.")   
 
 st.sidebar.divider()
 st.sidebar.info(

frontend/🏡_Home.py

@@ -1,7 +1,5 @@
 import streamlit as st
 from Login import auth_page
-from PIL import Image 
-import textwrap
 
 import base64
 
@@ -9,7 +7,7 @@ st.set_page_config(
     page_title="Techdocs",
     layout="wide",
     page_icon="🏡",
-    initial_sidebar_state="expanded",
+    initial_sidebar_state="expanded"
 )
 
 @st.cache_data