From b72a1bb9f7f4e1f0974000ef6d0e4a0d2bb6b2f1 Mon Sep 17 00:00:00 2001 From: stuffinator Date: Mon, 15 Nov 2021 21:27:40 +0100 Subject: [PATCH] Django-Postgres application template created (#178) In this template is shown how to connect Djnago and PostgreSQL using docker-compose servise. Signed-off-by: Ulugbek Muslitdinov --- django-postgres/Dockerfile | 16 +++ django-postgres/README.md | 83 +++++++++++ django-postgres/django_app/__init__.py | 0 .../__pycache__/__init__.cpython-310.pyc | Bin 0 -> 197 bytes .../__pycache__/settings.cpython-310.pyc | Bin 0 -> 2349 bytes .../__pycache__/urls.cpython-310.pyc | Bin 0 -> 977 bytes .../__pycache__/wsgi.cpython-310.pyc | Bin 0 -> 606 bytes django-postgres/django_app/asgi.py | 16 +++ django-postgres/django_app/settings.py | 129 ++++++++++++++++++ django-postgres/django_app/urls.py | 21 +++ django-postgres/django_app/wsgi.py | 16 +++ django-postgres/docker-compose.yml | 24 ++++ django-postgres/manage.py | 22 +++ django-postgres/requirements.txt | 3 + vuejs/README.md | 2 +- 15 files changed, 331 insertions(+), 1 deletion(-) create mode 100644 django-postgres/Dockerfile create mode 100644 django-postgres/README.md create mode 100644 django-postgres/django_app/__init__.py create mode 100644 django-postgres/django_app/__pycache__/__init__.cpython-310.pyc create mode 100644 django-postgres/django_app/__pycache__/settings.cpython-310.pyc create mode 100644 django-postgres/django_app/__pycache__/urls.cpython-310.pyc create mode 100644 django-postgres/django_app/__pycache__/wsgi.cpython-310.pyc create mode 100644 django-postgres/django_app/asgi.py create mode 100644 django-postgres/django_app/settings.py create mode 100644 django-postgres/django_app/urls.py create mode 100644 django-postgres/django_app/wsgi.py create mode 100644 django-postgres/docker-compose.yml create mode 100644 django-postgres/manage.py create mode 100644 django-postgres/requirements.txt diff --git a/django-postgres/Dockerfile b/django-postgres/Dockerfile new file mode 100644 index 0000000..fed2614 --- /dev/null +++ b/django-postgres/Dockerfile @@ -0,0 +1,16 @@ +# Pull base image +FROM python:3.8 + +# Set environment variables +ENV PYTHONDONTWRITEBYTECODE 1 +ENV PYTHONUNBUFFERED 1 + +# Set work directory +WORKDIR /code + +# Install dependencies +COPY requirements.txt /code/ +RUN pip3 install -r requirements.txt --no-cache-dir + +# Copy project +COPY . /code/ \ No newline at end of file diff --git a/django-postgres/README.md b/django-postgres/README.md new file mode 100644 index 0000000..4d505c3 --- /dev/null +++ b/django-postgres/README.md @@ -0,0 +1,83 @@ +# Compose sample application + +## Django application with PostgreSQL support + +Project structure: +``` +. +├── docker-compose.yml +├── Dockerfile +├── requirements.txt +├── manage.py +├── django_app + ├── settings.py + ├── urls.py + └── wsgi.py +``` + +[docker-compose.yml](https://github.com/docker/awesome-compose/blob/master/django-postgres/docker-compose.yml) + +```yaml +services: + web: + build: . + ports: + - 8000:8000 + depends_on: + - db + db: + image: postgres:11 + ports: + - 5432:5432 + +volumes: + postgres_data: +``` + +# Changes in Django project +To make your Django project work with PostgreSQL, you need to add the following lines to your settings.py file: +```python +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql', + 'NAME': 'postgres', + 'USER': 'postgres', + 'PASSWORD': 'postgres', + 'HOST': 'db', + 'PORT': 5432 + } +} +``` + +# Deploy with docker-compose +``` +$ docker-compose up -d +[+] Building 27.5s (10/10) FINISHED + => [internal] load build definition from Dockerfile + => => transferring dockerfile: 340B + ... + ... + [+] Running 4/4 + ⠿ Network django-postgres_default Created 0.1s + ⠿ Volume "django-postgres_postgres_data" Created 0.0s + ⠿ Container django-postgres-db-1 Started 2.9s + ⠿ Container django-postgres-web-1 Started +``` + + +# Expected result +Listing containers must showtwo containers running and the port mapping as below: +``` +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +9a3b782b1b5a django-postgres_web "python /code/manage…" 12 minutes ago Up 12 minutes 0.0.0.0:8000->8000/tcp django-postgres-web-1 +de27369602f3 postgres:11 "docker-entrypoint.s…" 12 minutes ago Up 12 minutes 0.0.0.0:5432->5432/tcp django-postgres-db-1 +``` + +After the application starts, navigate to ```http://localhost:8000``` in your web browser. + +To stop and remove containers, run: +``` +$ docker-compose down +``` + diff --git a/django-postgres/django_app/__init__.py b/django-postgres/django_app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/django-postgres/django_app/__pycache__/__init__.cpython-310.pyc b/django-postgres/django_app/__pycache__/__init__.cpython-310.pyc new file mode 100644 index 0000000000000000000000000000000000000000..90733d01149846e65457ed9f0a9339402b40e7ca GIT binary patch literal 197 zcmd1j<>g`kg6bPH5<&E15P=LBfgA@QE@lA|DGb33nv8xc8Hzx{2;yrhkn3y}6Iz^F zR179#{PR*>iZaVmV=gSXu;IeS3;Qm%U)XVBr^3a?i%l2yUDzFySe{y(pPQ$b*2E>^h;*sF+u3!p0hXp+IHUC`vj@!xXWXvp@F>^>X z^L@^o?QaGymN%yZ~1^E|q!bEQjmh3B|J zZO8WdzC8Uy)}C~AWKy<~OFW4(J7iQQRGbxV#&E?AVdrUAjr5;EGLq*KXapz2vZxzwF+?@9ynf zUMk^hSFS&~;xFC$FuGh0j8Zl_GlG%3zQ;ncC8wlDi__8pM7%U5OkA+X*j|8Xbbd-n zF{MEBQH2W%yAK{0r#%>KOgGsMTFOP`vDPIBIe6C&v7D}xusvB%77UZ-fiAi=4K@xh zPx$L2*@Rc=Xb{+G*Z1UV`uGo18usKW437xjoiP1iDi<5bo6JLjci@e5(?XnZoLtfuBdS^=Lk3)-X$dHEqNiP5!bn4?xQ!druW^xiQnL;M7qhDF!M zwg+{ZkopGXgzRW}%J_iDH#qF;N@AQ_QK}EsR?QS^^>sbYEA6(G&T?AYsB0~KzXejx zc4?o;Kpt?NZe*N8xMvR>c2L=9>ySeF#32kXM+Fd$=OrP|s;#wpOO3^r(p1Ad^mp`N zD)+Q{0-MrZKSUOsAq1u2VZ9k>nb_1X5J z|0l=wA2myRoZ}(D{o?|(1}+Xs_b5UJd*uN&XF5hT%2(j1hpwqaZ;x?-O4mo&q4Emp zLs$8$1Uslzx)A3q3r=y%igN*+l@8eo1>iQ$TUK(uB=Qhb-+7ATYyd}#$ISeSqN~Yn z#|2%juB(RiQ2i{<)YO&ET3l2b4Q)fMSr0Vb(BqT!mTrIu1W+P+Txiy7wT8N(tgG?d zx~3UcXT4F?TC4G_p*GtM#ZdKlenVfYC-#kcRY|HTo~Z;Od7#76Ptkt^OsD00c?*Jd^@F#{@_3ma;PBa}iH4oQ9@)U0lpAUZ={xp2~ z>YL%u!(XIVU%vWk_;UE`ro9X7xws66W#Ci1Iogjh%vm3Z9ls}Cvbq1Al!LuE{}F80 zz`^(6+t1Mk3?er-H$Nlh#2Hb@XY#XRK@bIA;PZm;TKrplEzS!$fzR^dKQJ$XOq{s? N5*I})$@OQTIRCau;!Y$p4FK*^jrtL#Dm(RvDkT6o4Lc?r19JdcBrc1u?6KbF{XJ= zPM$p`1Hq^1Y$>Tu1^4|Ib0DWnndMY#kX)UTELECFvDBc<0Y$VRXDOVkkQ@m~n28o*`cDZ8h_gBd_6qJN>2@4f>-K1yb30^pwK`nV!L@_*i@{ zz7&_M_r=%Z8(F@(Hgjiv7Sj#)!MXnWU#~hqHNw_B3Wi| T=pvjl@7Hr$H(GA1-u&|yM6o(| literal 0 HcmV?d00001 diff --git a/django-postgres/django_app/__pycache__/wsgi.cpython-310.pyc b/django-postgres/django_app/__pycache__/wsgi.cpython-310.pyc new file mode 100644 index 0000000000000000000000000000000000000000..b16520b4e59d2d3badf21964935fcc0b4803d0e7 GIT binary patch literal 606 zcmYjP!EO^V5cO`-rYsa8fjIjbiR>b{RR|T45(PnWNGqghrHxrnHjcdZ%61c4PQZa* z;DS_++~5X6>Njj|Xs?|30Pf5tRMe8kGak>pH#63|y8*%V`sWAs(IeznZCqYWH1=`Z zyC^sr6YgvR_P)L1}gL2W*W+DoHV@JrK?Nzrja7lev7j;3Sy4`*HXwVxbql3f4 z{-8HXo)5c6&kjy+{%=5N!8xHa+iq2@BtaHQQu*3eH#Tp=6iW!}%*IEoss(Bxj8;{E zfgGmnSi0)!CD6~r)Z<)>KMb|Ud-0J4W7jesD(D)qfVey>zm#9g^VR$ETlt-?-mKo1 z=jD%>Ey3y>I#_%?jCez%gSyKM*nf6iW?Zuhi<4^S!DccK@%Ip0qc_RUm23WWKk)wo DGfT)) literal 0 HcmV?d00001 diff --git a/django-postgres/django_app/asgi.py b/django-postgres/django_app/asgi.py new file mode 100644 index 0000000..c694e78 --- /dev/null +++ b/django-postgres/django_app/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for django_app project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_app.settings') + +application = get_asgi_application() diff --git a/django-postgres/django_app/settings.py b/django-postgres/django_app/settings.py new file mode 100644 index 0000000..4f8c3df --- /dev/null +++ b/django-postgres/django_app/settings.py @@ -0,0 +1,129 @@ +""" +Django settings for django_app project. + +Generated by 'django-admin startproject' using Django 3.2.8. + +For more information on this file, see +https://docs.djangoproject.com/en/3.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.2/ref/settings/ +""" + +from pathlib import Path + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-wz=lazac12szp%asf(4861lt)o3m0e$yj#1)e(%+q%o149z#-p' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'django_app.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'django_app.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/2.2/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql', + 'NAME': 'postgres', + 'USER': 'postgres', + 'PASSWORD': 'postgres', + 'HOST': 'db', + 'PORT': 5432 + } +} + + +# Password validation +# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/3.2/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/3.2/howto/static-files/ + +STATIC_URL = '/static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/django-postgres/django_app/urls.py b/django-postgres/django_app/urls.py new file mode 100644 index 0000000..e2b61a7 --- /dev/null +++ b/django-postgres/django_app/urls.py @@ -0,0 +1,21 @@ +"""django_app URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/3.2/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import path + +urlpatterns = [ + path('admin/', admin.site.urls), +] diff --git a/django-postgres/django_app/wsgi.py b/django-postgres/django_app/wsgi.py new file mode 100644 index 0000000..d79e070 --- /dev/null +++ b/django-postgres/django_app/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for django_app project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_app.settings') + +application = get_wsgi_application() diff --git a/django-postgres/docker-compose.yml b/django-postgres/docker-compose.yml new file mode 100644 index 0000000..27bdd67 --- /dev/null +++ b/django-postgres/docker-compose.yml @@ -0,0 +1,24 @@ +version: '3.8' + +services: + web: + build: . + command: python /code/manage.py runserver 0.0.0.0:8000 # For local development +# command: gunicorn config.wsgi -b 0.0.0.0:8000 # For production + volumes: + - .:/code + ports: + - 8000:8000 + depends_on: + - db + db: + image: postgres:11 + volumes: + - postgres_data:/var/lib/postgresql/data/ + ports: + - 5432:5432 + environment: + - "POSTGRES_HOST_AUTH_METHOD=trust" + +volumes: + postgres_data: \ No newline at end of file diff --git a/django-postgres/manage.py b/django-postgres/manage.py new file mode 100644 index 0000000..dc49ae3 --- /dev/null +++ b/django-postgres/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_app.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/django-postgres/requirements.txt b/django-postgres/requirements.txt new file mode 100644 index 0000000..0251bb9 --- /dev/null +++ b/django-postgres/requirements.txt @@ -0,0 +1,3 @@ +Django==3.2.7 +psycopg2-binary==2.8.4 +environs==7.3.1 \ No newline at end of file diff --git a/vuejs/README.md b/vuejs/README.md index 0ed5d30..c336103 100644 --- a/vuejs/README.md +++ b/vuejs/README.md @@ -22,7 +22,7 @@ services: - ./vuejs:/project - /project/node_modules ``` -The compose file defines an application with one service `sparkjava`. +The compose file defines an application with one service `vuejs`. When deploying the application, docker-compose maps port 8080 of the web service container to port 8080 of the host as specified in the file. Make sure port 8080 on the host is not already being in use.