Generates accurate and custom-structured unit test documentation based on uploaded user info. User inputs desired test documentation structure through a pdf/docx, uploads test case data, and a description of the test through natural language. Created during a software developer internship at Insulet Corporation for use case of creating test case documentation for software.
- Flask (Backend)
- HTML, CSS (Frontend Styling)
- JavaScript (Client-Side Logic)
- GPT 3.5 (AI Model Integration)
- PyPDF2, python-docx (File Handling)
- Document Uploading: Users can upload a document in PDF or DOCX format.
- Interactive Chat: Users can chat with the AI model and receive structured replies.
- Themed Design: A simple and elegant design, with styled chat bubbles.
Make sure you have Flask and the other dependencies installed, as outlined in the requirements.txt file.
Download TestDocTemplate.pdf from the repo or any other template you wish to format your created document with in a pdf format. Save it to a location you will remember later for use.
-
Clone the repository:
git clone https://github.com/your-username/OpenAI-Flask-Document-Generator.git
-
Navigate to the project directory:
cd OpenAI-Flask-Document-Generator
-
Install the required dependencies:
pip install -r requirements.txt
-
Type your OpenAI key in app.py:
-
Run the Flask application:
python app.py
-
Open your browser and navigate to
http://localhost:5000/chat_pageto access the chat interface.
Feel free to fork the project and submit pull requests for any enhancements, bug fixes, or other contributions.
This project is licensed under the MIT License. See the LICENSE.md file for details.