diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 01147bd..5dd4554 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,20 @@ 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 test_requirements.txt + linters: runs-on: ubuntu-latest @@ -16,6 +30,9 @@ jobs: with: python-version: 3.11 + - name: Install requirements + run: python -m pip install -r test_requirements.txt + - name: Install pre-commit run: python -m pip install --upgrade pre-commit diff --git a/README.md b/README.md index a48e690..50f3612 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,12 @@ This is my educational project within IT KPI Python mentorship program by @webknjaz. ## Installation - -Soon - +``` +git clone +``` +``` +pip install requirements.txt +``` ## Usage diff --git a/dev_requirements.txt b/dev_requirements.txt new file mode 100644 index 0000000..7fb0ea1 --- /dev/null +++ b/dev_requirements.txt @@ -0,0 +1 @@ +pylint 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..970d6a8 --- /dev/null +++ b/mysite/__init__.py @@ -0,0 +1,6 @@ +""" +My educational Django project. + +This is my blog using Django 3.2.18 created as part of the IT KPI Python +mentorship program by @webknjaz. +""" 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.txt b/requirements.txt new file mode 100644 index 0000000..a03c104 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +asgiref == 3.7.2 + # via django +django == 3.2.20 +pytz == 2023.3 + # via django +sqlparse == 0.4.4 + # via django