From a7ac99bf4c150da7b12a5aec65616218dbca8d71 Mon Sep 17 00:00:00 2001 From: AnthoniaOkafor Date: Wed, 13 May 2020 19:02:48 +0100 Subject: [PATCH 1/4] integrated Django into the Puthon template --- src/goal3/__init__.py | 0 src/goal3/asgi.py | 16 ++++++ src/goal3/settings.py | 131 ++++++++++++++++++++++++++++++++++++++++++ src/goal3/urls.py | 21 +++++++ src/goal3/wsgi.py | 16 ++++++ src/manage.py | 21 +++++++ 6 files changed, 205 insertions(+) create mode 100644 src/goal3/__init__.py create mode 100644 src/goal3/asgi.py create mode 100644 src/goal3/settings.py create mode 100644 src/goal3/urls.py create mode 100644 src/goal3/wsgi.py create mode 100644 src/manage.py diff --git a/src/goal3/__init__.py b/src/goal3/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/goal3/asgi.py b/src/goal3/asgi.py new file mode 100644 index 0000000..37f79ad --- /dev/null +++ b/src/goal3/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for goal3 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.0/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'goal3.settings') + +application = get_asgi_application() diff --git a/src/goal3/settings.py b/src/goal3/settings.py new file mode 100644 index 0000000..eb46307 --- /dev/null +++ b/src/goal3/settings.py @@ -0,0 +1,131 @@ +""" +Django settings for goal3 project. + +Generated by 'django-admin startproject' using Django 3.0.6. + +For more information on this file, see +https://docs.djangoproject.com/en/3.0/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.0/ref/settings/ +""" + +import os + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'e-yzyyzm459mefh0k6!!b-8l(bnvh8&f6@o5_l4#7m!jmp3*g8' + +# 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 = 'goal3.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 = 'goal3.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/3.0/ref/settings/#databases + +""" +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), + } +} +""" + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql', + 'NAME': 'road-accidents', + 'USER': 'postgres', + 'PASSWORD': 'password', + 'HOST': 'localhost' + } +} + +# Password validation +# https://docs.djangoproject.com/en/3.0/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.0/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.0/howto/static-files/ + +STATIC_URL = '/static/' diff --git a/src/goal3/urls.py b/src/goal3/urls.py new file mode 100644 index 0000000..9b4001e --- /dev/null +++ b/src/goal3/urls.py @@ -0,0 +1,21 @@ +"""goal3 URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/3.0/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/src/goal3/wsgi.py b/src/goal3/wsgi.py new file mode 100644 index 0000000..7fe177e --- /dev/null +++ b/src/goal3/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for goal3 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.0/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'goal3.settings') + +application = get_wsgi_application() diff --git a/src/manage.py b/src/manage.py new file mode 100644 index 0000000..1cea6d4 --- /dev/null +++ b/src/manage.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'goal3.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() From ce38741dd571b37e54cb0cba44724668bd941155 Mon Sep 17 00:00:00 2001 From: AnthoniaOkafor Date: Wed, 13 May 2020 19:31:51 +0100 Subject: [PATCH 2/4] included requirements.txt for Django dependencies --- src/requirements.txt | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 src/requirements.txt diff --git a/src/requirements.txt b/src/requirements.txt new file mode 100644 index 0000000..653001d --- /dev/null +++ b/src/requirements.txt @@ -0,0 +1,5 @@ +asgiref==3.2.7 +Django==3.0.6 +psycopg2==2.8.5 +pytz==2020.1 +sqlparse==0.3.1 From 8ad14fae27f76081ff03168c80dcf65c8cf83379 Mon Sep 17 00:00:00 2001 From: AnthoniaOkafor Date: Fri, 15 May 2020 16:11:12 +0100 Subject: [PATCH 3/4] addressed failing check in codacy review --- .gitignore | 1 + src/goal3/asgi.py | 3 +-- src/goal3/settings.py | 11 +---------- src/goal3/wsgi.py | 3 +-- 4 files changed, 4 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index 9ca031c..0c10c07 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ # FILES **/**/.pyc .DS_Store +.env # DIRECTORIES **/**/__pycache__ diff --git a/src/goal3/asgi.py b/src/goal3/asgi.py index 37f79ad..32fb171 100644 --- a/src/goal3/asgi.py +++ b/src/goal3/asgi.py @@ -1,5 +1,4 @@ -""" -ASGI config for goal3 project. +"""ASGI config for goal3 project. It exposes the ASGI callable as a module-level variable named ``application``. diff --git a/src/goal3/settings.py b/src/goal3/settings.py index eb46307..37dd6c9 100644 --- a/src/goal3/settings.py +++ b/src/goal3/settings.py @@ -20,7 +20,7 @@ # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = 'e-yzyyzm459mefh0k6!!b-8l(bnvh8&f6@o5_l4#7m!jmp3*g8' +SECRET_KEY = os.environ['DJANGO_SECRET_KEY'] # SECURITY WARNING: don't run with debug turned on in production! DEBUG = True @@ -73,15 +73,6 @@ # Database # https://docs.djangoproject.com/en/3.0/ref/settings/#databases -""" -DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), - } -} -""" - DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', diff --git a/src/goal3/wsgi.py b/src/goal3/wsgi.py index 7fe177e..9559e41 100644 --- a/src/goal3/wsgi.py +++ b/src/goal3/wsgi.py @@ -1,5 +1,4 @@ -""" -WSGI config for goal3 project. +"""WSGI config for goal3 project. It exposes the WSGI callable as a module-level variable named ``application``. From 9998b3f6853514e3d1fc50265c48f00cc687ed70 Mon Sep 17 00:00:00 2001 From: AnthoniaOkafor Date: Fri, 15 May 2020 22:43:11 +0100 Subject: [PATCH 4/4] installed and wrote django rest_framework in settings.py --- src/goal3/settings.py | 13 +++++++++++-- src/requirements.txt | 11 +++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/src/goal3/settings.py b/src/goal3/settings.py index 37dd6c9..65adad8 100644 --- a/src/goal3/settings.py +++ b/src/goal3/settings.py @@ -1,5 +1,4 @@ -""" -Django settings for goal3 project. +"""Django settings for goal3 project. Generated by 'django-admin startproject' using Django 3.0.6. @@ -20,6 +19,15 @@ # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! +import os +import dotenv + +# Add .env variables anywhere before SECRET_KEY +dotenv_file = os.path.join(BASE_DIR, ".env") +if os.path.isfile(dotenv_file): + dotenv.load_dotenv(dotenv_file) + +# Update secret key SECRET_KEY = os.environ['DJANGO_SECRET_KEY'] # SECURITY WARNING: don't run with debug turned on in production! @@ -37,6 +45,7 @@ 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', + 'rest_framework', ] MIDDLEWARE = [ diff --git a/src/requirements.txt b/src/requirements.txt index 653001d..d4d8c63 100644 --- a/src/requirements.txt +++ b/src/requirements.txt @@ -1,5 +1,16 @@ asgiref==3.2.7 +astroid==2.4.1 +colorama==0.4.3 Django==3.0.6 +djangorestframework==3.11.0 +isort==4.3.21 +lazy-object-proxy==1.4.3 +mccabe==0.6.1 psycopg2==2.8.5 +pylint==2.5.2 +python-dotenv==0.13.0 pytz==2020.1 +six==1.14.0 sqlparse==0.3.1 +toml==0.10.1 +wrapt==1.12.1