Merge pull request #126 from codebanesr/feature/django

App rewrite in django

Author: codebanesr

.env.docker

@@ -0,0 +1,43 @@
+# For azure, can take either of azure or openai, for openai we will only need the key
+OPENAI_API_TYPE=openai
+AZURE_OPENAI_API_BASE=
+AZURE_OPENAI_API_KEY=
+AZURE_OPENAI_API_VERSION=2023-03-15-preview
+AZURE_OPENAI_EMBEDDING_MODEL_NAME=
+AZURE_OPENAI_DEPLOYMENT_NAME=
+AZURE_OPENAI_COMPLETION_MODEL=gpt-35-turbo
+
+
+# For openai
+OPENAI_API_KEY=
+
+
+
+# azure | openai
+EMBEDDING_PROVIDER=azure
+
+# Vector Store, PINECONE|QDRANT
+STORE=QDRANT
+
+
+# if using pinecone
+PINECONE_API_KEY=
+PINECONE_ENV=
+VECTOR_STORE_INDEX_NAME=
+
+
+# if using qdrant
+QDRANT_URL=http://qdrant:6333
+
+
+# optional, defaults to 15
+MAX_PAGES_CRAWL=1
+
+# --- these will change if you decide to start testing the software
+CELERY_BROKER_URL=redis://redis:6379/0
+CELERY_RESULT_BACKEND=redis://redis:6379/0
+DATABASE_NAME=openchat
+DATABASE_USER=dbuser
+DATABASE_PASSWORD=dbpass
+DATABASE_HOST=mysql
+DATABASE_PORT=3306

Makefile

@@ -61,3 +61,16 @@ down:
 exec-backend-server:
 	$(DOCKER_COMPOSE) exec backend-server bash
 .PHONY: install down
+
+
+# Makefile to Run docker-compose for Django App
+
+.env.docker:
+	@echo "Error: The .env.docker file is missing. Please create it before proceeding. Refer readme"
+	@exit 1
+
+install_django: .env.docker
+	@docker-compose -f docker-compose.django.yaml up -d
+
+uninstall_django:
+	@docker-compose -f docker-compose.django.yaml down

README.md

@@ -121,9 +121,15 @@ make install
 make.bat
 ```
 
+Sure, here's the modified text with the additional line you requested:
 
-Once the installation is complete, you can access the OpenChat console at: http://localhost:8000
+## Getting Started with the Openchat Django App
+
+Start your adventure of contributing to and using OpenChat, now remade using the Python programming language. You can begin by following the instructions in the guide available here: [OpenChat Python Guide](docs/django_release.md).
 
+**Kindly be aware that the transition to the Python backend includes a significant alteration related to the Qdrant vector store, constituting a breaking change.**
+
+Once the installation is complete, you can access the OpenChat console at: http://localhost:8000
 
 Documentation [available here](https://docs.openchat.so/introduction)
 

common.env

@@ -1,19 +1,19 @@
 # Required for openai azure ------------------------------------------------------------------
-# USE_AZURE_OPENAI=true
-# AZURE_OPENAI_API_KEY=1ddb532d770a414581c0ed9987c9ac2d
-# AZURE_OPENAI_API_INSTANCE_NAME=shanurrahman
-# AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME=emailclassifier
-# AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME=emailclassifierembedding
-# AZURE_OPENAI_API_VERSION=2023-03-15-preview
+USE_AZURE_OPENAI=true
+AZURE_OPENAI_API_KEY=
+AZURE_OPENAI_API_INSTANCE_NAME=
+AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME=
+AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME=
+AZURE_OPENAI_API_VERSION=2023-03-15-preview
 # --------------------------------------------------------------------------------------------
 
 OPENAI_API_KEY=
 
-STORE=qdrant
+STORE=pinecone
 
 PINECONE_API_KEY=
 PINECONE_ENVIRONMENT=
-PINECONE_INDEX_NAME=
+VECTOR_STORE_INDEX_NAME=
 
 # QDRANT_URL
 QDRANT_URL=http://qdrant:6333

dj_backend_server/.gitignore

@@ -0,0 +1,38 @@
+# Ignore general OS and text editor files
+*.pyc
+__pycache__/
+*.pyo
+*.pyd
+*.swp
+.DS_Store
+Thumbs.db
+desktop.ini
+
+# Ignore Django-specific files
+*.log
+*.pot
+*.pyc
+local_settings.py
+db.sqlite3
+media
+staticfiles
+
+# Ignore development and environment files
+.env
+.env.*
+*.envrc
+.env.local
+.env.*.local
+*.sqlite3
+*.db
+*.sqlite
+*.pdb
+*.env
+*.pyc
+*.orig
+*.egg-info/
+*.egg-info
+pip-log.txt
+pip-delete-this-directory.txt
+website_data_sources/*
+venv

dj_backend_server/.vscode/launch.json

@@ -0,0 +1,39 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Django",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/manage.py",
+            "args": [
+                "runserver"
+            ],
+            "django": true,
+            "justMyCode": true
+        },
+        {
+            "name": "Python: Celery Workers",
+            "type": "python",
+            "request": "launch",
+            // "program": "${workspaceFolder}/path_to_celery_executable",
+            "module": "celery",
+            "args": [
+                "-A",
+                "dj_backend_server",
+                "worker",
+                "-l",
+                "debug"
+            ],
+            "env": {
+                "OBJC_DISABLE_INITIALIZE_FORK_SAFETY": "YES",
+                "DISABLE_SPRING": "true"
+            },
+            "console": "integratedTerminal",
+            "envFile": "${workspaceFolder}/.env"
+        }               
+    ]
+}

dj_backend_server/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.python"
+    },
+    "python.formatting.provider": "none"
+}

dj_backend_server/Dockerfile

@@ -0,0 +1,18 @@
+# Use an official Python runtime as a parent image
+FROM python:3.9
+
+# Set environment variables for the project
+ENV PYTHONUNBUFFERED 1
+ENV DJANGO_SETTINGS_MODULE=dj_backend_server.settings
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Copy the current directory contents into the container at /app
+COPY . /app/
+
+# Install any needed packages specified in requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Run migrations on startup
+CMD ["sh", "-c", "python manage.py migrate && python manage.py runserver 0.0.0.0:8000"]

dj_backend_server/api/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.