From acd80aa55668cbde41ff9a4d0fe51a2b3fb7bfed Mon Sep 17 00:00:00 2001 From: martoxa Date: Wed, 3 May 2023 10:37:14 +0300 Subject: [PATCH] Set up a new Django project It adds a collection of settings for an instance of Django, including database configuration, Django-specific options, and application-specific settings. Ref #16 --- .github/workflows/ci.yml | 20 +++++++ README.md | 19 ++++++- manage.py | 23 ++++++++ mysite/__init__.py | 7 +++ mysite/asgi.py | 9 ++++ mysite/settings.py | 111 +++++++++++++++++++++++++++++++++++++++ mysite/urls.py | 8 +++ mysite/wsgi.py | 9 ++++ requirements/base.in | 1 + requirements/base.txt | 14 +++++ requirements/dev.in | 2 + requirements/dev.txt | 24 +++++++++ 12 files changed, 245 insertions(+), 2 deletions(-) create mode 100755 manage.py create mode 100644 mysite/__init__.py create mode 100644 mysite/asgi.py create mode 100644 mysite/settings.py create mode 100644 mysite/urls.py create mode 100644 mysite/wsgi.py create mode 100644 requirements/base.in create mode 100644 requirements/base.txt create mode 100644 requirements/dev.in create mode 100644 requirements/dev.txt diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 01147bd..f3eb63a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,23 @@ on: pull_request: jobs: + tests: + runs-on: ubuntu-latest + + steps: + - name: Fetch the src + uses: actions/checkout@v3 + - name: Set up Python 3.11 + uses: actions/setup-python@v4 + with: + python-version: 3.11 + + - name: Install requirements + run: python -m pip install -r requirements/dev.txt + + - name: Run tests + run: python -m manage.py test + linters: runs-on: ubuntu-latest @@ -16,6 +33,9 @@ jobs: with: python-version: 3.11 + - name: Install requirements + run: python -m pip install -r requirements/dev.txt + - name: Install pre-commit run: python -m pip install --upgrade pre-commit diff --git a/README.md b/README.md index a48e690..bb8cb3c 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,28 @@ This is my educational project within IT KPI Python mentorship program by @webkn ## Installation -Soon +1. Clone this repository: +```console +git clone https://github.com/kpi-web-guild/django-girls-blog-Martolivna.git +``` +or: +```console +git clone git@github.com:kpi-web-guild/django-girls-blog-Martolivna.git +``` +2. Install requirements: +```console +pip install -r requirements/base.txt +``` ## Usage -Soon +1. Start the server: +```console +python manage.py runserver +``` + ## Contributing diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..45669d6 --- /dev/null +++ b/manage.py @@ -0,0 +1,23 @@ +#!/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', 'mysite.settings') + try: + # pylint: disable-next=import-outside-toplevel + 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/mysite/__init__.py b/mysite/__init__.py new file mode 100644 index 0000000..788e7f8 --- /dev/null +++ b/mysite/__init__.py @@ -0,0 +1,7 @@ +""" +A Django blog project. + +This module contains the main configuration settings for the Django +project, including database settings, middleware, installed apps, +URL configurations, static files, and other key configuration options. +""" diff --git a/mysite/asgi.py b/mysite/asgi.py new file mode 100644 index 0000000..7338b44 --- /dev/null +++ b/mysite/asgi.py @@ -0,0 +1,9 @@ +"""ASGI config for mysite project.""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings') + +application = get_asgi_application() diff --git a/mysite/settings.py b/mysite/settings.py new file mode 100644 index 0000000..3e04f11 --- /dev/null +++ b/mysite/settings.py @@ -0,0 +1,111 @@ +""" +Django settings for mysite project. + +Configuration file for Django project "mysite" using Django 3.2.18. + +Includes various settings such as the secret key, debug mode, allowed +hosts, installed apps, middleware, database configuration, password +validators, internationalization settings, static file settings, and +the default primary key field type. +""" +from pathlib import Path + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'notsecuretempkey' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = ['127.0.0.1'] + + +# 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 = 'mysite.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 = 'mysite.wsgi.application' + + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + }, +} + + +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', + }, +] + + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'Europe/Kyiv' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +STATIC_URL = '/static/' +STATIC_ROOT = BASE_DIR / 'static' + + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/mysite/urls.py b/mysite/urls.py new file mode 100644 index 0000000..b12f532 --- /dev/null +++ b/mysite/urls.py @@ -0,0 +1,8 @@ +"""mysite URL Configuration.""" + +from django.contrib import admin +from django.urls import path + +urlpatterns = [ + path('admin/', admin.site.urls), +] diff --git a/mysite/wsgi.py b/mysite/wsgi.py new file mode 100644 index 0000000..b3d1ead --- /dev/null +++ b/mysite/wsgi.py @@ -0,0 +1,9 @@ +"""WSGI config for mysite project.""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings') + +application = get_wsgi_application() diff --git a/requirements/base.in b/requirements/base.in new file mode 100644 index 0000000..1aec109 --- /dev/null +++ b/requirements/base.in @@ -0,0 +1 @@ +Django ~= 3.0 diff --git a/requirements/base.txt b/requirements/base.txt new file mode 100644 index 0000000..4c1cf46 --- /dev/null +++ b/requirements/base.txt @@ -0,0 +1,14 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile --constraint=dev.txt base.in +# +asgiref == 3.7.2 + # via django +django == 3.2.20 + # via -r base.in +pytz == 2023.3 + # via django +sqlparse == 0.4.4 + # via django diff --git a/requirements/dev.in b/requirements/dev.in new file mode 100644 index 0000000..6fb8a3e --- /dev/null +++ b/requirements/dev.in @@ -0,0 +1,2 @@ +-c base.in +pylint diff --git a/requirements/dev.txt b/requirements/dev.txt new file mode 100644 index 0000000..99c414b --- /dev/null +++ b/requirements/dev.txt @@ -0,0 +1,24 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile dev.in +# +astroid == 2.15.6 + # via pylint +dill == 0.3.7 + # via pylint +isort == 5.12.0 + # via pylint +lazy-object-proxy == 1.9.0 + # via astroid +mccabe == 0.7.0 + # via pylint +platformdirs == 3.10.0 + # via pylint +pylint == 2.17.5 + # via -r dev.in +tomlkit == 0.12.1 + # via pylint +wrapt == 1.15.0 + # via astroid