Merge branch 'master' of github.com:abolfazl8131/devops_gpt

Author: abolfazl8131

.github/workflows/ci.yml

@@ -37,11 +37,11 @@ jobs:
               "template": "#{{CHANGELOG}}",
               "categories": [
                 {
-                    "title": "## Feature",
+                    "title": "## 🚀 Features",
                     "labels": ["feat", "feature"]
                 },
                 {
-                    "title": "## Fix",
+                    "title": "## 🐛 Fixes",
                     "labels": ["fix", "bug"]
                 },
                 {

.github/workflows/docker.yml

@@ -0,0 +1,30 @@
+name: Docker Health Check
+
+on:
+  pull_request:
+    branches:
+      - master
+      
+jobs:
+ docker_health_check:
+    runs-on: ubuntu-latest
+    steps:
+    
+    - uses: actions/checkout@v4
+    - name: install requirements
+      run: pip install -r requirements.txt
+      
+    - name: docker login
+      uses: docker/login-action@v3
+      with:
+        username: 81318131
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        
+    - name: build services
+      run: docker compose build
+      
+    - name: run services
+      run: docker compose up --build -d
+      
+    - name: stop containers
+      run: docker compose down

.github/workflows/pylint.yml

@@ -0,0 +1,27 @@
+name: Pylint
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+        pip install -r requirements.txt
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files 'app/main.py') --disable=R,C,W

Dockerfile

@@ -1,21 +1,9 @@
 FROM python:3.11-alpine
-
 RUN apk add --no-cache shadow
-
 RUN useradd -ms /bin/bash admin
-
 WORKDIR /code
-
-
 COPY ./requirements.txt /code/requirements.txt
-
-
 RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
-
-
 COPY ./app /code/app
-
-
 RUN chown -R admin /code/app/*
-
-USER admin
+USER admin

README.md

@@ -1,12 +1,55 @@
 # DevOps-GPT
-Use a brilliant assistant as your friend on your DevOps journey.
+Use a brilliant assistant as your friend in your DevOps journey.
 
 ## What does this project offer?
 This project helps you to balance your daily work as a DevOps engineer, from simple bug fixes to project template generation.<br />
 you don't need to search on Google for some routine jobs and it helps you with a robust prompt to simplify your career.
 
+## How it works?
+This is a wrapper between DevOps engineers and large language models like GPT-4-mini. The main strength of it is prompt engineering.<br />
+
+We have developed some (Extendable) prompt-driven solutions with a simplified interface for the DevOps process cost reduction.<br />
+
+### Docker services
+We run our services using docker-compose (the main Fast-API-based backend and MongoDB), so we package all dependencies and don't use any external service.<br />
+The second one is Mongodb. we need to save the prompt and GPT-4_mini response in the Mongo document for future use. (for example, fine-tuning the other model with our data) <br />
+
+### Media directory
+The third one is in the media directory. for now, We save a project called (MyTerraform) which is a Terraform template generated based on user requirements. so users can download it and use it.<be />
+surely we can save any static data in the `/media`.
+
+![teramedia](https://github.com/user-attachments/assets/b8e10d83-68ac-4efc-b064-45f1d1a870dc)
+
+This is an example of a template generated in the `/media`
+
+and the input is something like that
+
+![Screenshot from 2024-10-27 10-56-54](https://github.com/user-attachments/assets/63d1db07-2c25-4c10-a841-69a2c1235d9d)
+
+
+
+### directory_generator.py
+This file becomes updated when we trigger the template generation API. finally, It generates the MyTerraform directory based on user input which is a template.
+
+
 ## ToolChain
 1. Python
 2. Docker
 3. GPT-4-mini
 4. FastAPI
+
+## Pre-requisites
+1. Python
+2. Docker
+
+## How to use?
+execute `sh run.sh` in your terminal
+
+> [!WARNING]  
+> Do Not change the GPT model! Prompts have been developed for the GPT-4-mini model and they can't be integrated with other GPT models. it can cause horrible incompatibility.
+
+
+> 
+# Maintenance
+** [Abolfazl Andalib](https://github.com/abolfazl8131) - abolfazlandalib@gmail.com **<br />
+** [Mohammad Madanipour](https://github.com/mohammadll) - m.madanipourr@gmail.com **

app/main.py

@@ -74,4 +74,4 @@ def list_directory(folder: str):
 
     # List the contents of the directory
     contents = os.listdir(folder)
-    return {"folder": folder, "contents": contents}
+    return {"folder": folder, "contents": contents}