mtkumar123 / csc510_project_lectureaid Goto Github PK

Once all source files are updated, run the documentation tool and update the documentation branch

Using sphinx or other documentation tools, use auto-hooks to integrate with github pages

Using the header and paragraph keywords, research ways to create wordclouds in python. Then, integrate into existing code.

needs owner access for zenodo, which will be used for CITATION.md

Currently, we are using the maximum number of threads (10) for running search queries, but could still be room for improvement using other multithreading/multiprocessing tools.

Currently Spacy is being used to extract noun phrases from each slide/page of the document. Then the high frequency noun phrases are calculated and used in the final search query. However this causes an issue when every slide has the document’s author name and email address listed. The author name is considered as a noun phrase, and since it appears on every slide has a high frequency, and thus appears on the final search query.

Using the documentation branch, update the documentation and README.md

Results and word cloud image

Build a browser extension which lets the user to select text from a webpage and send a request to the application and get the links of pdf webpages.

Create more API keys for google search, so that we can round robing through the API keys for each search query

Implement Concurrency threading for faster execution times.

Using black and flake8 code checkers, reformat code and add requirement to build.

A button can be added beside each link in the results in both the site and results.html file to save those links to browser bookmarks.

Our project is currently using a command line interface to get input, and output a .html file. A roadmap item would be to implement a website instead. This way the user would open up the Lecture Aid website, be able to add a file to the website, and click a button to process the file. Then, the website would display the results (wordcloud and question and answers). This will make it easier for users to use the project, without having to download/execute code locally.

Need to add comments in files that have way too few comments and need to remove commented lines of code that are not used.

Need to determine what methods are/aren't being used and refactor. Right now we have search_api_controller and methods within google_search that aren't being used

Need to update the following files to conform to PEP standards:

Module code.user_cli
code/user_cli.py:82:4: W0601: Global variable 'WORDCLOUD_FILE_NAME' undefined at the module level (global-variable-undefined)

Combine all the steps, and create User Facing Terminal Menu

Currently the project supports only PDF format for the uploaded files. In future all other formats possibly which are used by the professors in the lectures should also be supported.
Eg : PPT, .DOCX, .ZIP