OVRAT_BACKEND

These are all backend modules for the OVRAT project structure

Sure, here's a markdown file for installing and configuring a Django Rest Framework project with SimpleJWT authentication using mkvirtualenv:

Installing and Configuring Django Rest Framework Project with SimpleJWT Authentication

Prerequisites

• Python 3 installed on your machine
• pip package manager installed on your machine
• virtualenvwrapper installed on your machine

Installation

1. Install virtualenvwrapper:

pip install virtualenvwrapper

2. Add the following lines to your ~/.bashrc or ~/.zshrc file:

export WORKON_HOME=$HOME/.virtualenvs
source /usr/local/bin/virtualenvwrapper.sh

3. Create a new virtual environment:

mkvirtualenv myprojectenv

4. Activate the virtual environment:

workon myprojectenv

5. Install Django and Django Rest Framework:

pip install django
pip install djangorestframework

6. Install SimpleJWT:

pip install djangorestframework-simplejwt

Configuration

1. Create a new Django project:

django-admin startproject myproject

2. Create a new Django app:

cd myproject
python manage.py startapp myapp

3. Add 'rest_framework' and 'rest_framework_simplejwt' to the INSTALLED_APPS list in settings.py:

INSTALLED_APPS = [
    # ...
    'rest_framework',
    'rest_framework_simplejwt',
]

4. Configure SimpleJWT authentication in settings.py:

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ),
}

from datetime import timedelta

SIMPLE_JWT = {
    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=30),
    'REFRESH_TOKEN_LIFETIME': timedelta(days=1),
    'ROTATE_REFRESH_TOKENS': True,
}

5. Configure URL routing in urls.py:

from django.urls import path, include
from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView

urlpatterns = [
    path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),
    path('api/token/refresh/', TokenRefreshView.as_view(), name='token_refresh'),
    # ...
]

6. Create a serializer in serializers.py:

from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = '__all__'

7. Create a view in views.py:

from rest_framework import generics, permissions
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelList(generics.ListCreateAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    permission_classes = [permissions.IsAuthenticated]

8. Configure URL routing for the view in urls.py:

from django.urls import path
from .views import MyModelList

urlpatterns = [
    path('mymodel/', MyModelList.as_view()),
    # ...
]

9. Migrate your database:

python manage.py migrate

10. Run your server:

python manage.py runserver

That's it! You should now have a functioning Django Rest Framework project with SimpleJWT authentication.

Description de l'API

Configuration et Installation

Ici il s'agit de comment installer et cofiguer le projet chez soit

• clonner de repositiry
• installez python dans votre machine
• installez VIRTUELEN via la commande

---

pip install virtualenvwraper-win

---

• créez un environement vituel via la commande

---

mkvirtualen non_env

---

• ouvrez le repo avec vs code, ouvrez le terminal
• activez l'nvironnement virtuel avec la commande

---

workon nom_env 

---

• Installez les dépendences via la commande

---

pip install -r requirements.txt

---

• Tapez la commande suivante pour lancer le projet

---

py mannage.py runserver

---

API Reference

Get all items

  POST :  /api/token/

Parameter	Type	Description
username	string	Required.
password	string	Required.

ici il s'agit de la route qui va permettre d'avoir un token d'authentification

update profille

  GET, POST :  update_profile/

Parameter	Type	Description
last_name	string	Required.
first_name	string	Not required.
email	string	Required.
username	string	Required.

change password

POST :  change_password/

Parameter	Type	Description
old_password	string	Required.
password	string	Required.
confirm_password	string	Required.

reset password get token in email

POST :  reset_password_get_token/

Parameter	Type	Description
email	string	Required.

reset password get token in email

POST :  reset_password_confirm/{uidb64}/{token}

Parameter	Type	Description
email	string	Required.

Url Parameter	Type	Description
uidb64	userid in base64	Required.
token	string	Required.

cources categories

  GET /api/categories/

Json Returning

Parameter	Type	Description
id	int
name	string

courses

  GET /api/courses/
  POST /api/courses/

Json Returning

Parameter	Type	Description
id	int
name	string
description	string
instructor	User
categories	Array of gategories

Json Watting for POST method

Parameter	Type	Description
name	string	Required
description	string	Required
instructor	User	Required
categories	Array of gategories	Required

Single course

  GET /api/courses/{id}/
  PUT  /api/courses/{id}/
  DELETE /api/courses/{id}/

Json Returning

Parameter	Type	Description
id	int
name	string
description	string
instructor	User
categories	Array of gategories

Json Watting for POST and PUT method

Parameter	Type	Description
name	string
description	string
instructor	User
categories	Array of gategories

courses

  GET /api/lessons/
  POST /api/lessons/

Json Returning

Parameter	Type	Description
id	int
name	string
description	string
instructor	User
categories	Array of gategories

Json Watting for POST method

Parameter	Type	Description
name	string	Required
description	string	Required
instructor	User id	Required
categories	Array of gategories	Required

Single lesson

  GET /api/lessons/{id}/
  PUT  /api/lessons/{id}/
  DELETE /api/lessons/{id}/

Json Returning

Parameter	Type	Description
id	int
title	string
content	string
course	Course object

Json Watting for POST and PUT method

Parameter	Type	Description
title	string	Required
content	string	Required
course	Course id	Required