diff --git a/.gitignore b/.gitignore index aa5d4b2..6b3a796 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # ---> VisualStudioCode -.vscode/* +*.vscode/* +*.vscode* !.vscode/settings.json !.vscode/tasks.json !.vscode/launch.json diff --git a/CourseMaster/__init__.py b/CourseMaster/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/CourseMaster/asgi.py b/CourseMaster/asgi.py new file mode 100644 index 0000000..9564d35 --- /dev/null +++ b/CourseMaster/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for CourseMaster 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/4.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'CourseMaster.settings') + +application = get_asgi_application() diff --git a/CourseMaster/settings.py b/CourseMaster/settings.py new file mode 100644 index 0000000..c53fcf0 --- /dev/null +++ b/CourseMaster/settings.py @@ -0,0 +1,130 @@ +""" +Django settings for CourseMaster project. + +Generated by 'django-admin startproject' using Django 4.2.16. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/4.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/4.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-3ib(8=@cwv%48&0@r1c)inr_*l*-ky$q!8*f_x2&*8a(1_mxb#' + +# 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', + 'redis', + 'debug_toolbar', +] + +MIDDLEWARE = [ + 'debug_toolbar.middleware.DebugToolbarMiddleware', + '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', +] + +INTERNAL_IPS = [ + '127.0.0.1', +] + +ROOT_URLCONF = 'CourseMaster.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 = 'CourseMaster.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/4.2/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/4.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/4.2/topics/i18n/ + +LANGUAGE_CODE = 'fr-fr' + +TIME_ZONE = 'Europe/Paris' + +USE_I18N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/4.2/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/CourseMaster/urls.py b/CourseMaster/urls.py new file mode 100644 index 0000000..014ef7f --- /dev/null +++ b/CourseMaster/urls.py @@ -0,0 +1,25 @@ +""" +URL configuration for CourseMaster project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.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, include +import debug_toolbar + +urlpatterns = [ + path('admin/', admin.site.urls), + path('redis/', include('redis.urls')), + path('__debug__/', include(debug_toolbar.urls)) +] diff --git a/CourseMaster/wsgi.py b/CourseMaster/wsgi.py new file mode 100644 index 0000000..c773ac1 --- /dev/null +++ b/CourseMaster/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for CourseMaster 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/4.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'CourseMaster.settings') + +application = get_wsgi_application() diff --git a/Pipfile b/Pipfile index 36be345..ce44188 100644 --- a/Pipfile +++ b/Pipfile @@ -5,6 +5,7 @@ name = "pypi" [packages] django = "*" +django-debug-toolbar = "*" [dev-packages] diff --git a/Pipfile.lock b/Pipfile.lock index 27a7b84..49fbf71 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "c36ae28fea7b9a4cc02145632e2f41469af2e7b38b801903abb8333d3306f36b" + "sha256": "70f227b62b3344f08f8e6a8707201bf94fec08faba28bdc3c6ecea5ff8be1d61" }, "pipfile-spec": 6, "requires": { @@ -33,6 +33,15 @@ "markers": "python_version >= '3.8'", "version": "==4.2.16" }, + "django-debug-toolbar": { + "hashes": [ + "sha256:36e421cb908c2f0675e07f9f41e3d1d8618dc386392ec82d23bcfcd5d29c7044", + "sha256:3beb671c9ec44ffb817fad2780667f172bd1c067dbcabad6268ce39a81335f45" + ], + "index": "pypi", + "markers": "python_version >= '3.8'", + "version": "==4.4.6" + }, "sqlparse": { "hashes": [ "sha256:773dcbf9a5ab44a090f3441e2180efe2560220203dc2f8c0b0fa141e18b505e4", diff --git a/README.md b/README.md index 549f789..15c9388 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Django project +# Course Master - Django project ## Installation @@ -21,3 +21,18 @@ Then, install pipenv with `pip3 install pipenv` Now, you can install Django by doing `pipenv install django`. This will create you a virtual environment and install Django into it. + +## Configuration + +In the repo folder, type `pipenv shell`. This will lead you to the venv of the project. + +Then, type `python manage.py runserver` when you're in the repo root folder. + +## Usage + +Now, you can go into https://localhost:8000/redis to access the project. + +Don't try to go into https://localhost:8000/admin, you won't have the rights and it's only used for development mode. This helps us to add/remove data to test quicker. + +## Features + diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..8e3c5f4 --- /dev/null +++ b/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', 'CourseMaster.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/redis/__init__.py b/redis/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/redis/admin.py b/redis/admin.py new file mode 100644 index 0000000..c70a7c4 --- /dev/null +++ b/redis/admin.py @@ -0,0 +1,6 @@ +from django.contrib import admin + +from .models import Course, Person + +admin.site.register(Course) +admin.site.register(Person) \ No newline at end of file diff --git a/redis/apps.py b/redis/apps.py new file mode 100644 index 0000000..2ef68ad --- /dev/null +++ b/redis/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class RedisConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'redis' diff --git a/redis/migrations/0001_initial.py b/redis/migrations/0001_initial.py new file mode 100644 index 0000000..157fa77 --- /dev/null +++ b/redis/migrations/0001_initial.py @@ -0,0 +1,34 @@ +# Generated by Django 4.2.16 on 2024-10-12 19:54 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='Course', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('title', models.CharField(max_length=200)), + ('summary', models.CharField(max_length=1000)), + ('level', models.CharField(choices=[('B', 'Beginner'), ('I', 'Intermediate'), ('A', 'Advanced')], default='B', max_length=12)), + ('places', models.IntegerField(default=0)), + ], + ), + migrations.CreateModel( + name='Person', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(max_length=200)), + ('role', models.CharField(choices=[('Student', 'Student'), ('Teacher', 'Teacher')], default='Student', max_length=7)), + ('courses', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='redis.course')), + ], + ), + ] diff --git a/redis/migrations/__init__.py b/redis/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/redis/models.py b/redis/models.py new file mode 100644 index 0000000..82406b8 --- /dev/null +++ b/redis/models.py @@ -0,0 +1,50 @@ +from django.db import models + +# Utils function to truncate my string when it's too long (use in to string method) +def truncate_string(text): + if len(text) > 15: + return text[:15] + "..." + else: + return text + +class Course(models.Model): + # Defining choices for the course level + BEGINNER = "B" + INTERMEDIATE = "I" + ADVANCED = "A" + LEVELS_CHOICES = [ + (BEGINNER, "Beginner"), + (INTERMEDIATE, "Intermediate"), + (ADVANCED, "Advanced"), + ] + + # Defining our attributes which equal the Course table's columns + title = models.CharField(max_length=200) + summary = models.CharField(max_length=1000) + level = models.CharField(choices=LEVELS_CHOICES, default=BEGINNER, max_length=12) + places = models.IntegerField(default=0) + + # Utils function + def __str__(self): + return self.title + " " + truncate_string(self.summary) + +# Student or teacher, what differs? For teachers, courses will be the courses taught, and for students, the courses followed. +# However, this only deferrs into a 'role'. If it's a teacher, then the courses are taught, else they are followed. +# All the logic can be simplified with the role attribute. Later, we'll also be able to check permission with this attribute. +class Person(models.Model): + # Defining choices for the course level + STUDENT = "Student" + TEACHER = "Teacher" + ROLE_CHOICES = [ + (STUDENT, "Student"), + (TEACHER, "Teacher"), + ] + + # Defining our attributes which equal the Course table's columns + name = models.CharField(max_length=200) + courses = models.ForeignKey(Course, on_delete=models.CASCADE) + role = models.CharField(choices=ROLE_CHOICES, default=STUDENT, max_length=7) + + # Utils function + def __str__(self): + return self.name + " is a " + self.role \ No newline at end of file diff --git a/redis/templates/home.html b/redis/templates/home.html new file mode 100644 index 0000000..4ef112a --- /dev/null +++ b/redis/templates/home.html @@ -0,0 +1,9 @@ + + + {% if name %} +

Welcome {{ name }}!

+ {% else %} +

Welcome young padawan!

+ {% endif %} + + \ No newline at end of file diff --git a/redis/tests.py b/redis/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/redis/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/redis/urls.py b/redis/urls.py new file mode 100644 index 0000000..6e62d02 --- /dev/null +++ b/redis/urls.py @@ -0,0 +1,6 @@ +from django.urls import path +from . import views + +urlpatterns = [ + path('', views.home, name='home') +] \ No newline at end of file diff --git a/redis/views.py b/redis/views.py new file mode 100644 index 0000000..26b8bc9 --- /dev/null +++ b/redis/views.py @@ -0,0 +1,4 @@ +from django.shortcuts import render + +def home(request): + return render(request, 'home.html', {'name': 'Plheyer'}) \ No newline at end of file