Feature/refactor apps

.dockerignore

@@ -0,0 +1,10 @@
+**/__pycache__
+*.pyc
+venv
+.venv
+.pytest_cache
+.git
+.gitignore
+.coverage
+staticfiles/
+oc_lettings_site\storage.py

.github/workflows/CI.yml

@@ -0,0 +1,63 @@
+name: CI pipeline
+
+on:
+  push:
+    branches : 
+      - feature/refactor-apps
+  pull_request:
+    branches : 
+      - feature/refactor-apps
+
+
+jobs:
+  test-lint-build:
+    runs-on: ubuntu-latest
+
+    env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+          SENTRY_KEY: ${{ secrets.SENTRY_KEY }}
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt 
+          pip install flake8 pytest
+
+      - name: Lint with flake8 
+        run: |
+          echo "Running flake8 with setup.cfg"
+          flake8 . 
+
+      - name: Run tests with pytest        
+        run: |
+          echo "Running tests ..."
+          pytest     
+
+
+      - name: Docker login
+        uses: docker/login-action@v2
+        with:
+          registry: docker.io
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build Docker 
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true 
+          tags: ${{ secrets.DOCKER_USERNAME }}/my-django-app:latest
+
+      - name: Trigger Render Deploy Hook
+        run: curl -X POST ${{ secrets.RENDER_DEPLOY_HOOK }}

.gitignore

@@ -1,3 +1,9 @@
 **/__pycache__
 *.pyc
 venv
+.venv
+.pytest_cache
+.env
+.coverage
+staticfiles/
+build/

.readthedocs.yml

@@ -0,0 +1,25 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+   builder: html
+
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements.txt

Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.11-slim
+
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1\
+    DEBUG=False \
+    DJANGO_SETTINGS_MODULE=oc_lettings_site.settings
+
+
+ARG SECRET_KEY=xtokenforbuildonly
+ENV SECRET_KEY=${SECRET_KEY}
+
+WORKDIR /app
+
+COPY . /app/
+
+
+RUN pip install --no-cache-dir --upgrade pip setuptools wheel
+RUN pip install --no-cache-dir -r requirements.txt
+
+RUN python manage.py collectstatic --noinput 
+
+EXPOSE 8000
+
+CMD ["gunicorn", "oc_lettings_site.wsgi:application", "--bind", "0.0.0.0:8000"]

README.md

@@ -75,3 +75,81 @@ Utilisation de PowerShell, comme ci-dessus sauf :
 
 - Pour activer l'environnement virtuel, `.\venv\Scripts\Activate.ps1` 
 - Remplacer `which <my-command>` par `(Get-Command <my-command>).Path`
+
+### Fichier .env
+Le projet utilise un fichier `.env` pour centraliser les variables d'environnement sensibles.
+
+Créez un fichier `.env` à la racine du projet avec comme variable:
+  - SECRET_KEY
+  - SENTRY_DSN
+  - SECRET_DEPLOY_HOOK
+
+Ne pas commit ce fichier dans Git, il doit être listé dans le `.gitignore`
+
+
+### Docker
+
+L'application dispose d'un `Dockerfile` pour créer une image Docker exécutable:
+commande pour la création de l'image `docker build -t oc-lettings .`
+
+Pour la partie CI/CD:
+- Créer un compte docker sur Docker Hub (https://hub.docker.com/)
+- Configurer vos identifiants dans les **secrets GitHub**:
+  - `DOCKER_USERNAME`
+  - `DOCKER_PASSWORD`(sous forme de token)
+
+### CI/CD:
+
+Un pipeline GitHub a été ajouté, déclenché à chaque push.
+Il execute automatiquement les étapes suivantes:
+
+- Lint avec `flake8`
+- Tests unitaires avec `pytest`
+- Build Docker
+- Push vers Docker Hub
+- Génération de la documentation
+
+
+### Documentation 
+
+La documentation technique est générée avec **Sphinx** et hebergée sur **Read the Docs**:
+
+Créer sa propre doc 
+
+1. Créer un compte sur https://readthedocs.org
+2. Connecter votre repo GitHub
+3. Importer le projet 
+4. S'assurer que `.readthedocs.yml` est présent à la racine
+5. Déclencher un build 
+
+### Sentry
+
+Étapes pour intégrer Sentry:
+
+  1. Créer un compte sur https://sentry.io 
+  2. Créer un projet Django
+  3. Copier la clé DSN dans votre environnement de variable (.env)
+  4. Ajouter le bloc de code de sentry générée dans sentry et la Clé DSN dans `oc_lettings_site/settings.py`
+
+
+### Déploiement 
+
+Render est connecté à Docker Hub pour tirer l'image automatiquement.
+
+**Étapes pour configurer**
+
+1. Créer un compte render (https://render.com)
+2. Créer un Web service
+3. Indiquer l'image Docker :
+``` 
+  docker.io/nom utilisateur/nom de l'application
+
+```
+4. Déploiement automatique à chaque image pushée
+
+Exemple de lien de production :
+  https://oc-lettings.onrender.com
+
+
+
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,44 @@
+import os
+import sys
+
+import django
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+os.environ["DJANGO_SETTINGS_MODULE"] = "docs.source.doc_settings"
+
+
+django.setup()
+
+project = "oc-lettings"
+copyright = "2025, mehdi"
+author = "mehdi"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+language = "fr"
+local_dirs = ["locales/"]
+gettex_compact = False
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

docs/source/doc_settings.py

@@ -0,0 +1,18 @@
+SECRET_KEY = "clef_secrète_pour_la_doc"
+
+
+INSTALLED_APPS = [
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "oc_lettings_site",
+    "lettings",
+    "profiles",
+]
+
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+    }
+}

docs/source/index.rst

@@ -0,0 +1,19 @@
+.. oc-lettings documentation master file, created by
+   sphinx-quickstart on Fri May 30 13:39:36 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+oc-lettings documentation
+=========================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   presentation
+   modules

docs/source/modules.rst

@@ -0,0 +1,16 @@
+Documentation des modules 
+=========================
+
+
+.. automodule:: lettings.models
+   :members:
+
+
+.. automodule:: lettings.views
+   :members: 
+
+.. automodule:: profiles.models
+   :members:
+
+.. automodule:: profiles.views
+   :members:    

docs/source/presentation.rst

@@ -0,0 +1,11 @@
+Présentation du projet 
+======================
+
+
+
+Ce projet est un site Django qui permet de gérer des annonces de locations et des profils utilisateurs.
+
+Fonctionalités : 
+- Navigation des profils
+- Liste des locations 
+- Accés à l'administraiion du site via Django admin