redex-ai / Simple-Plagiarism-Checker

Web Application for checking the similarity between query and document using the concept of Cosine Similarity.
1 stars 0 forks source link

REDEX #13

Open redex-ai opened 10 months ago

redex-ai commented 10 months ago

Add another plagiarism checking technique

redex-ai-karthickmj[bot] commented 10 months ago

Change Summary

The change involves adding a new plagiarism checking technique to the Flask application. This includes backend changes to handle the new route and calculations, frontend changes to add a new form and display results, and possibly client-side JavaScript changes for asynchronous behavior.

FilePlan :-

File : plag.py

Add a new route and function to handle the new plagiarism checking technique. This will involve preprocessing the input query, performing the new plagiarism check, and returning the result.

File : templates/index.html

Add a new form for the new plagiarism checking technique with appropriate input fields and a submit button. Also, add a section to display the results returned by the new plagiarism check route. The changes in this file is dependent on : -

Dependent File : plag.py,

File : static/js/main.js

If there is any client-side JavaScript, add the necessary event handlers and AJAX calls for the new form to asynchronously submit the data and display the results without reloading the page. The changes in this file is dependent on : -

Dependent File : templates/index.html,

File : new_plagiarism_technique.py

Create a new Python file that contains the implementation of the new plagiarism checking technique. This file will include functions to preprocess the text and calculate the plagiarism score.

Steps after merging :-

After merging the code, the developer should test the new plagiarism checking technique to ensure it works as expected. If there are any new dependencies introduced, the developer should update the 'req.txt' file and install them using 'pip install -r req.txt'.

Please review the structure and let me know if any modifications are required.

redex-ai-karthickmj[bot] commented 10 months ago

PULL REQUEST : https://github.com/redex-ai/Simple-Plagiarism-Checker/pull/14

redex-ai commented 10 months ago

Can you please add logs?

redex-ai-karthickmj[bot] commented 10 months ago

Change Summary

The change involves adding a new plagiarism checking technique to the Flask application, along with logging to track the application's behavior and any issues. This includes backend changes to handle the new route and calculations, frontend changes to add a new form and display results, and possibly client-side JavaScript changes for asynchronous behavior.

FilePlan :-

File : plag.py

Add a new route and function to handle the new plagiarism checking technique. Implement logging within the function to track the flow and any errors. This will involve preprocessing the input query, performing the new plagiarism check, calculating the result, and logging the process.

File : templates/index.html

Add a new form for the new plagiarism checking technique with appropriate input fields and a submit button. Also, add a section to display the results returned by the new plagiarism check route. Ensure that the form includes necessary client-side validation. The changes in this file is dependent on : -

Dependent File : plag.py,

File : static/js/main.js

If there is any client-side JavaScript, add the necessary event handlers and AJAX calls for the new form to asynchronously submit the data and display the results without reloading the page. Include logging for client-side events and errors. The changes in this file is dependent on : -

Dependent File : templates/index.html,

File : new_plagiarism_technique.py

Create a new Python file that contains the implementation of the new plagiarism checking technique. This file will include functions to preprocess the text, calculate the plagiarism score, and log the steps and results of the calculation.

Steps after merging :-

After merging the code, the developer should test the new plagiarism checking technique to ensure it works as expected. If there are any new dependencies introduced, the developer should update the 'req.txt' file and install them using 'pip install -r req.txt'. Additionally, review the logs to verify that they are capturing the necessary information and that there are no unexpected errors.

Please review the structure and let me know if any modifications are required.

redex-ai-karthickmj[bot] commented 10 months ago

PULL REQUEST : https://github.com/redex-ai/Simple-Plagiarism-Checker/pull/15

redex-ai commented 10 months ago

Can you please add more logs?

redex-ai-karthickmj[bot] commented 10 months ago

Change Summary (Revision: 1)

Addressed comment:

Can you please add more logs?

The change plan involves adding a new plagiarism checking technique to the Flask application with a focus on enhancing logging throughout the system. This includes backend changes for the new route and plagiarism checking logic, frontend updates for the new form and results display, and client-side JavaScript for asynchronous interactions.

FilePlan :-

File : plag.py

Enhance the existing logging within the Flask application to include more detailed information, such as timestamps, request data, and specific steps of the plagiarism checking process. Add a new route and function to handle the new plagiarism checking technique, ensuring that detailed logging is implemented throughout the function to track the flow, results, and any errors.

File : templates/index.html

Update the HTML template to include a new form for the additional plagiarism checking technique. This form should have the necessary input fields, a submit button, and a section to display the results. Ensure that the form action points to the new route created in 'plag.py'. Update the template to display additional log information if needed. The changes in this file is dependent on : -

Dependent File : plag.py,

File : static/js/main.js

Add or update JavaScript code to handle the new form submission via AJAX, ensuring that detailed logging is added for client-side events, errors, and server responses. This will enhance the user experience by providing real-time feedback without page reloads. The changes in this file is dependent on : -

Dependent File : templates/index.html,

File : new_plagiarism_technique.py

Create a new Python file dedicated to the new plagiarism checking technique. This file should include robust logging throughout the text preprocessing and plagiarism score calculation functions, capturing detailed information about each step and any exceptions that occur.

Steps after merging :-

After merging the code, developers should test the new plagiarism checking technique to ensure it functions correctly. Update the 'req.txt' file if new dependencies are introduced and install them using 'pip install -r req.txt'. Review the enhanced logs to verify that they capture detailed information and that there are no unexpected errors.

Please review the structure and let me know if any modifications are required.

redex-ai-karthickmj[bot] commented 10 months ago

PULL REQUEST : https://github.com/redex-ai/Simple-Plagiarism-Checker/pull/16

redex-ai-karthickmj[bot] commented 10 months ago

PULL REQUEST : https://github.com/redex-ai/Simple-Plagiarism-Checker/pull/18