Inline docs & seperation

app.py

@@ -10,6 +10,9 @@ import uuid
 
 from beautiful_soup.beautiful_soup import get_url_content
 
+"""
+Request Google Search API with query and return results.
+"""
 @cache
 def google_search_api_request( query ):
     api_key = st.secrets["google_search_api_key"]
@@ -32,6 +35,9 @@ def google_search_api_request( query ):
         fields='items(title,link),searchInformation(totalResults)'
         ).execute()
 
+"""
+Request Google Search API with query and return results. Results are cached in files.
+"""
 def search_results( query ):
     file_path = 'search-results/' + slugify( query ) + '.json'
 
@@ -52,7 +58,10 @@ def search_results( query ):
     
     return results
 
-def content_summary( url_id, content ):
+"""
+Generate summary for content.
+"""
+def generate_summary( url_id, content ):
     file_path = 'summaries/' + url_id + '.json'
     makedirs(dirname(file_path), exist_ok=True)
     if exists( file_path ):
@@ -71,6 +80,9 @@ def content_summary( url_id, content ):
     
     return summary
 
+"""
+Helper function for exception notices.
+"""
 def exception_notice( exception ):
     query_params = st.experimental_get_query_params()
     if 'debug' in query_params.keys() and query_params['debug'][0] == 'true':
@@ -78,12 +90,23 @@ def exception_notice( exception ):
     else:
         st.warning(str(exception))
 
+"""
+Checks if string contains keyword.
+"""
 def is_keyword_in_string( keywords, string ):
     for keyword in keywords:
         if keyword in string:
             return True
     return False
 
+def filter_strings_by_keywords( strings, keywords ):
+    content = ''
+    for string in strings:
+        # Filter strings with keywords
+        if is_keyword_in_string( keywords, string ):
+            content += string + '\n'
+    return content
+
 def main():
     st.title('Racoon Search')
     query = st.text_input('Search query')
@@ -119,11 +142,10 @@ def main():
                 try:
                     strings = get_url_content( result['link'] )
                     keywords = query.split(' ')
-                    content = ''
-                    for string in strings:
-                        if is_keyword_in_string( keywords, string ):
-                            content += string + '\n'
-                    summary = content_summary( url_id, content )
+                    content = filter_strings_by_keywords( strings, keywords )
+                    # print(content)
+                    # print(len(content.split()))
+                    summary = generate_summary( url_id, content )
                     for sentence in summary:
                         st.write(sentence['summary_text'])
                 except Exception as exception: