init project

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  <yann@needsome.coffee>
+
+## License
+
+MIT License  
+Copyright (c) 2025 

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

softdesk/authentication/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

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'

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
+
+
+
+

softdesk/authentication/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

softdesk/authentication/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

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()

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()

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',)
+        }
+

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),
+]

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()

softdesk/support/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

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'

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"

softdesk/support/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

softdesk/support/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.