diff --git a/.github/workflows/backend_lint.yml b/.github/workflows/backend_lint.yml new file mode 100644 index 0000000..48b5ae5 --- /dev/null +++ b/.github/workflows/backend_lint.yml @@ -0,0 +1,38 @@ +name: Lint Backend Code + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' # Specify the Python version you need + + - name: Install dependencies + run: | + cd backend + python -m pip install --upgrade pip + pip install flake8 + + - name: Run flake8 for critical errors + run: | + cd backend + flake8 ./ --count --select=E9,F63,F7,F82 --show-source --statistics + + - name: Run flake8 for complexity and style issues + run: | + cd backend + flake8 ./ --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics diff --git a/backend/.flake8 b/backend/.flake8 new file mode 100644 index 0000000..a4a8261 --- /dev/null +++ b/backend/.flake8 @@ -0,0 +1,15 @@ +[flake8] +# it's not a bug that we aren't using all of hacking, ignore: +# F812: list comprehension redefines ... +# H101: Use TODO(NAME) +# H202: assertRaises Exception too broad +# H233: Python 3.x incompatible use of print operator +# H301: one import per line +# H306: imports not in alphabetical order (time, os) +# H401: docstring should not start with a space +# H403: multi line docstrings should end on a new line +# H404: multi line docstring should start without a leading new line +# H405: multi line docstring summary not separated with an empty line +# H501: Do not use self.__dict__ for string formatting +; ignore = F812,H101,H202,H233,H301,H306,H401,H403,H404,H405,H501 +exclude = __pycache__,tests.py,migrations,env \ No newline at end of file diff --git a/backend/.gitignore b/backend/.gitignore new file mode 100644 index 0000000..01ac695 --- /dev/null +++ b/backend/.gitignore @@ -0,0 +1,2 @@ +/env +__pycache__ \ No newline at end of file diff --git a/backend/BookShelf/__init__.py b/backend/BookShelf/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/backend/BookShelf/asgi.py b/backend/BookShelf/asgi.py new file mode 100644 index 0000000..5eca6ff --- /dev/null +++ b/backend/BookShelf/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for BookShelf 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/5.1/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'BookShelf.settings') + +application = get_asgi_application() diff --git a/backend/BookShelf/settings.py b/backend/BookShelf/settings.py new file mode 100644 index 0000000..311898a --- /dev/null +++ b/backend/BookShelf/settings.py @@ -0,0 +1,123 @@ +""" +Django settings for BookShelf project. + +Generated by 'django-admin startproject' using Django 5.1.1. + +For more information on this file, see +https://docs.djangoproject.com/en/5.1/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/5.1/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/5.1/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-vopex%6rpp)sa-9vcjl8g5afjb30hzyy1cwynvmrtv2y=^wu&_' # noqa + +# 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 = 'BookShelf.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 = 'BookShelf.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/5.1/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', # noqa + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', # noqa + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', # noqa + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', # noqa + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/5.1/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/5.1/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/backend/BookShelf/urls.py b/backend/BookShelf/urls.py new file mode 100644 index 0000000..50f44a0 --- /dev/null +++ b/backend/BookShelf/urls.py @@ -0,0 +1,22 @@ +""" +URL configuration for BookShelf project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/5.1/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/backend/BookShelf/wsgi.py b/backend/BookShelf/wsgi.py new file mode 100644 index 0000000..52fc9f6 --- /dev/null +++ b/backend/BookShelf/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for BookShelf 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/5.1/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'BookShelf.settings') + +application = get_wsgi_application() diff --git a/backend/db.sqlite3 b/backend/db.sqlite3 new file mode 100644 index 0000000..f4563ed Binary files /dev/null and b/backend/db.sqlite3 differ diff --git a/backend/manage.py b/backend/manage.py new file mode 100755 index 0000000..bb4c860 --- /dev/null +++ b/backend/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', 'BookShelf.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/backend/requirements.txt b/backend/requirements.txt new file mode 100644 index 0000000..eec1cf1 --- /dev/null +++ b/backend/requirements.txt @@ -0,0 +1 @@ +Django \ No newline at end of file