From 7fa6ecae22e77d95479f66752bfaf236817117cf Mon Sep 17 00:00:00 2001 From: yann Date: Thu, 22 May 2025 17:18:17 +0200 Subject: [PATCH] init project --- README.md | 69 +++++++++ requirements.txt | 11 ++ softdesk/authentication/__init__.py | 0 softdesk/authentication/admin.py | 3 + softdesk/authentication/apps.py | 6 + .../authentication/migrations/__init__.py | 0 softdesk/authentication/models.py | 10 ++ softdesk/authentication/tests.py | 3 + softdesk/authentication/views.py | 3 + softdesk/manage.py | 22 +++ softdesk/softdesk/__init__.py | 0 softdesk/softdesk/asgi.py | 16 +++ softdesk/softdesk/settings.py | 135 ++++++++++++++++++ softdesk/softdesk/urls.py | 22 +++ softdesk/softdesk/wsgi.py | 16 +++ softdesk/support/__init__.py | 0 softdesk/support/admin.py | 3 + softdesk/support/apps.py | 6 + softdesk/support/migrations/__init__.py | 0 softdesk/support/models.py | 51 +++++++ softdesk/support/tests.py | 3 + softdesk/support/views.py | 3 + 22 files changed, 382 insertions(+) create mode 100644 README.md create mode 100644 requirements.txt create mode 100644 softdesk/authentication/__init__.py create mode 100644 softdesk/authentication/admin.py create mode 100644 softdesk/authentication/apps.py create mode 100644 softdesk/authentication/migrations/__init__.py create mode 100644 softdesk/authentication/models.py create mode 100644 softdesk/authentication/tests.py create mode 100644 softdesk/authentication/views.py create mode 100755 softdesk/manage.py create mode 100644 softdesk/softdesk/__init__.py create mode 100644 softdesk/softdesk/asgi.py create mode 100644 softdesk/softdesk/settings.py create mode 100644 softdesk/softdesk/urls.py create mode 100644 softdesk/softdesk/wsgi.py create mode 100644 softdesk/support/__init__.py create mode 100644 softdesk/support/admin.py create mode 100644 softdesk/support/apps.py create mode 100644 softdesk/support/migrations/__init__.py create mode 100644 softdesk/support/models.py create mode 100644 softdesk/support/tests.py create mode 100644 softdesk/support/views.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8f0db5 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# OCR / DA Python - Project10 + +## SoftDesk + +Build a REST API using DjangoRestFramework + +- users, authors, contributors +- projects/issues/comments + +-> data models, user model, relations +-> authentication + +### Introduction + +These instructions allow you to : +- get the program +- install the required environment +- run and use it + +### Requirements + +1. modules +``` +packages : python 3.11, python3.11-venv, python3-pip, git +``` + +### Installation + +1. Clone this repo and go in the project's directory + +2. Create the virtual environment +``` +python3.11 -m venv env +source env/bin/activate +``` + +3. install environment +``` +pip install -r requirements.txt +``` + +## Execution + +1. Go in the Django project directory +``` +cd softdesk +``` +2. Initialize the database +``` +python manage.py migrate +``` +3. Launch the test's server +``` +python manage.py runserver +``` +## Use + +URL is : http://127.0.0.1:8000 +Endpoints and methods to come soon + + +## Author + +YaL + +## License + +MIT License +Copyright (c) 2025 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..72e7a51 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,11 @@ +asgiref==3.8.1 +certifi==2025.4.26 +charset-normalizer==3.4.2 +Django==5.2.1 +djangorestframework==3.16.0 +djangorestframework_simplejwt==5.5.0 +idna==3.10 +PyJWT==2.9.0 +requests==2.32.3 +sqlparse==0.5.3 +urllib3==2.4.0 diff --git a/softdesk/authentication/__init__.py b/softdesk/authentication/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/softdesk/authentication/admin.py b/softdesk/authentication/admin.py new file mode 100644 index 0000000..8c38f3f --- /dev/null +++ b/softdesk/authentication/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/softdesk/authentication/apps.py b/softdesk/authentication/apps.py new file mode 100644 index 0000000..8bab8df --- /dev/null +++ b/softdesk/authentication/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class AuthenticationConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'authentication' diff --git a/softdesk/authentication/migrations/__init__.py b/softdesk/authentication/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/softdesk/authentication/models.py b/softdesk/authentication/models.py new file mode 100644 index 0000000..61cd0b3 --- /dev/null +++ b/softdesk/authentication/models.py @@ -0,0 +1,10 @@ +from django.db import models +from django.contrib.auth.models import AbstractUser, Group + + +class User(AbstractUser): + pass + + + + diff --git a/softdesk/authentication/tests.py b/softdesk/authentication/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/softdesk/authentication/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/softdesk/authentication/views.py b/softdesk/authentication/views.py new file mode 100644 index 0000000..91ea44a --- /dev/null +++ b/softdesk/authentication/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here. diff --git a/softdesk/manage.py b/softdesk/manage.py new file mode 100755 index 0000000..eb5a8a6 --- /dev/null +++ b/softdesk/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', 'softdesk.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/softdesk/softdesk/__init__.py b/softdesk/softdesk/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/softdesk/softdesk/asgi.py b/softdesk/softdesk/asgi.py new file mode 100644 index 0000000..7d50c97 --- /dev/null +++ b/softdesk/softdesk/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for softdesk 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.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'softdesk.settings') + +application = get_asgi_application() diff --git a/softdesk/softdesk/settings.py b/softdesk/softdesk/settings.py new file mode 100644 index 0000000..2f6e98e --- /dev/null +++ b/softdesk/softdesk/settings.py @@ -0,0 +1,135 @@ +""" +Django settings for softdesk project. + +Generated by 'django-admin startproject' using Django 5.2.1. + +For more information on this file, see +https://docs.djangoproject.com/en/5.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/5.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/5.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-_vs15jeip&ba(7@n!ptk+b0$4fjhj-esfz1qrhk8+eh4d6k%br' + +# 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', + 'rest_framework', + 'rest_framework_simplejwt', + 'authentication', + 'support', +] + +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 = 'softdesk.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'softdesk.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/5.2/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/5.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/5.2/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.2/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' + +AUTH_USER_MODEL = 'authentication.User' + +REST_FRAMERWORK = { + 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination', + 'PAGE_SIZE': 5, + 'DEFAULT_AUTHENTICATION_CLASSES': ('rest_framework_simplejwt.authentication.JWTAuthentication',) + } + diff --git a/softdesk/softdesk/urls.py b/softdesk/softdesk/urls.py new file mode 100644 index 0000000..0986625 --- /dev/null +++ b/softdesk/softdesk/urls.py @@ -0,0 +1,22 @@ +""" +URL configuration for softdesk project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/5.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 + +urlpatterns = [ + path('admin/', admin.site.urls), +] diff --git a/softdesk/softdesk/wsgi.py b/softdesk/softdesk/wsgi.py new file mode 100644 index 0000000..f4cc3a7 --- /dev/null +++ b/softdesk/softdesk/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for softdesk 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.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'softdesk.settings') + +application = get_wsgi_application() diff --git a/softdesk/support/__init__.py b/softdesk/support/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/softdesk/support/admin.py b/softdesk/support/admin.py new file mode 100644 index 0000000..8c38f3f --- /dev/null +++ b/softdesk/support/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/softdesk/support/apps.py b/softdesk/support/apps.py new file mode 100644 index 0000000..e18c7be --- /dev/null +++ b/softdesk/support/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class SupportConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'support' diff --git a/softdesk/support/migrations/__init__.py b/softdesk/support/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/softdesk/support/models.py b/softdesk/support/models.py new file mode 100644 index 0000000..ec7e2fe --- /dev/null +++ b/softdesk/support/models.py @@ -0,0 +1,51 @@ +from django.db import models + + +class Project(models.Model): + author = + contributor = + + +class Issue(models.Model): + + class Priority(models.TextChoices): + LOW = 'L' + MEDIUM = 'M' + HIGH = 'H' + + + class Status(models.TextChoices): + TODO = 'ToDo' + INPROGRESS = 'InProgress' + FINISHED = 'Finished' + + + class Tag(models.TextChoices): + BUG = 'Bug' + FEATURE = 'Feature' + TASK = 'Task' + + + title = models.CharField(max_lenght=255, verbose_name='title') + description = models.TextField() + project = models.ForeignKey(Project, null=True, on_delete=models.SET_NULL, blank=True) + status = models.CharField(Status.choices, max_length=15) + priority = models.CharField(Priority.choices, max_lenght=15) + tag = models.CharField(Tag.choices, max_length=15) + + contributors = models.ManyToManyField( + settings.AUTH_USER_MODEL, through='IssueContributors', related_name='contributors') + assigned_to = + + +class Comment(models.Model): + + author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=SET + issue = models.ForeignKey(Issue, on_delete=models.CASCADE) + + + + +class IssueContributors(models.Model): + contributor = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.SET_NULL) + issue = "ToDo" diff --git a/softdesk/support/tests.py b/softdesk/support/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/softdesk/support/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/softdesk/support/views.py b/softdesk/support/views.py new file mode 100644 index 0000000..91ea44a --- /dev/null +++ b/softdesk/support/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here.