https://github.com/pmcode9992/documentationassistant
Documentation Assistant automates technical project documentation using GPT-3.5 Turbo, ensuring comprehensive and accurate records.
https://github.com/pmcode9992/documentationassistant
Last synced: about 1 year ago
JSON representation
Documentation Assistant automates technical project documentation using GPT-3.5 Turbo, ensuring comprehensive and accurate records.
- Host: GitHub
- URL: https://github.com/pmcode9992/documentationassistant
- Owner: pmcode9992
- Created: 2024-06-18T06:51:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-03T10:03:05.000Z (over 1 year ago)
- Last Synced: 2025-01-21T21:46:54.463Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 115 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation Assistant
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Ensure you have the following installed:
- Python 3.x
- pip
### Installation
1. **Clone the repository:**
```sh
git clone https://github.com/pmcode9992/DocumentationAssistant
cd DocumentationAssistant
```
2. **Install the required packages:**
```sh
pip install -r requirements.txt
```
3. **Set up the environment variables:**
Create a `.env` file in the root directory of the project with the following content:
```env
contextWindow=16000
SingleSession_APIKEY=your_openai_api_key
```
### Running the Application
To run the application, use the following command:
```sh
streamlit run main.py
```
## Usage
create the file structure, when satisfied with the file structure generated (ensure you remove build folders like node_modules, virtual environments etc
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.