Documentation

.github/workflows/main.yml

@@ -0,0 +1,58 @@
+name: Django CI/CD
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.8'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Collect static files
+      run: python manage.py collectstatic --noinput
+      env:
+        DJANGO_SETTINGS_MODULE: oc_lettings_site.settings
+    - name: Run linting
+      run: flake8 .
+
+    - name: Run tests with coverage
+      run: |
+        pytest --cov=./ --cov-report=term-missing:skip-covered --cov-fail-under=80
+
+  build-and-push-docker:
+    needs: build-and-test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build Docker image
+      run: docker build . -t ${{ secrets.DOCKER_USERNAME }}/myapp:${{ github.sha }}
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+
+    - name: Push Docker image to Docker Hub
+      run: docker push ${{ secrets.DOCKER_USERNAME }}/myapp:${{ github.sha }}
+
+    - name: Output Docker run command
+      run: "echo 'Run the following command to pull and run the Docker image locally: docker run -p 8000:8000 myapp:${{ github.sha }}'"
+    - name: Deploy to Render
+      run: |
+        curl -X POST -d '' "${{ secrets.RENDER_DEPLOY_HOOK }}"

.gitignore

@@ -1,3 +1,4 @@
 **/__pycache__
 *.pyc
-venv
+env
+.env

.readthedocs.yaml

@@ -0,0 +1,15 @@
+# .readthedocs.yaml
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: doc/conf.py
+
+
+python:
+  install:
+  - requirements: requirements.txt

README.md

@@ -60,8 +60,13 @@ Dans le reste de la documentation sur le développement local, il est supposé q
 - Se connecter à la base de données `.open oc-lettings-site.sqlite3`
 - Afficher les tables dans la base de données `.tables`
 - Afficher les colonnes dans le tableau des profils, `pragma table_info(Python-OC-Lettings-FR_profile);`
+    Faux
+  Afficher les colonnes dans le tableau des profils, `pragma table_info(oc_lettings_site_profile);`
 - Lancer une requête sur la table des profils, `select user_id, favorite_city from
   Python-OC-Lettings-FR_profile where favorite_city like 'B%';`
+    Faux
+  Lancer une requête sur la table des profils, `SELECT user_id, favorite_city FROM oc_lettings_site_profile WHERE favorite_city LIKE 'B%';`
+
 - `.quit` pour quitter
 
 #### Panel d'administration

doc/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     = .
+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)

doc/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: e5310faf057c669c38714cf216a1ddfb
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/_build/html/_sources/github_actions.rst.txt

@@ -0,0 +1,80 @@
+Github Actions
+===========
+
+YML file steps
+--------------------
+
+**Step 1: Install Python, packages from requirements.txt and
+link static assets to our project**
+
+.. code-block:: bash
+
+    name: Install dependencies
+    run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Collect static files
+        run: python manage.py collectstatic --noinput
+        env:
+        DJANGO_SETTINGS_MODULE: oc_lettings_site.settings
+
+**Step 2: Linting**
+
+.. code-block:: bash
+
+    - name: Run linting
+        run: flake8 .
+
+**Step 3: Tests with coverage **
+
+.. code-block:: bash
+
+    - name: Run tests with coverage
+        run: |
+        pytest --cov=./ --cov-report=term-missing:skip-covered --cov-fail-under=80
+
+**Step 4: Create Secrets for your github actions and use them**
+1. Inside yout project, on Github, go to settings, secrets and variables, click on action and on new repository secret,
+    add your docker username and your docker password like this:
+
+.. code-block:: bash
+
+    DOCKER_USERNAME="your_docker_username"
+    DOCKER_PASSWORD="your_docker_password"
+
+2. This is what we use inside the yml file to log and perform operations with docker:
+    .. code-block:: bash
+        - name: Build Docker image
+        run: docker build . -t ${{ secrets.DOCKER_USERNAME }}/myapp:${{ github.sha }}
+
+        - name: Log in to Docker Hub
+            uses: docker/login-action@v1
+        with:
+            username: ${{ secrets.DOCKER_USERNAME }}
+            password: ${{ secrets.DOCKER_PASSWORD }}
+
+**Step 5: Pushing the image to docker hub**
+
+.. code-block:: bash
+
+    - name: Push Docker image to Docker Hub
+        run: docker push ${{ secrets.DOCKER_USERNAME }}/myapp:${{ github.sha }}
+
+**Step 6: Deploy the image to render**
+1. Get your render deploy hook
+    - Go to Render, got to your dashboard
+    - Create a new web service
+    - In the settings of your service, link your reposiroty to it, add this start command :
+    .. code-block:: bash
+        python manage.py runserver 0.0.0.0:$PORT
+    -Copy the Deploy hook
+2. Add the secret variable inside github actions as we previously see as :
+
+.. code-block:: bash
+    RENDER_DEPLOY_HOOK="your_render_deploy_hook"
+
+3. This is what we use inside the yml file to link this project to your render web service :
+    .. code-block:: bash
+        - name: Deploy to Render
+            run: |
+            curl -X POST -d '' "${{ secrets.RENDER_DEPLOY_HOOK }}"

doc/_build/html/_sources/index.rst.txt

@@ -0,0 +1,27 @@
+.. oc_lettings documentation master file, created by
+   sphinx-quickstart on Fri Jun  7 14:32:43 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OC Lettings's Documentation!
+======================================
+
+This documentation covers the setup, usage, and other details of the OC Lettings application.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   presentation
+   structure
+   requirements
+   local_use
+   sentry_dsngithub_actions
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/_build/html/_sources/local_use.rst.txt

@@ -0,0 +1,71 @@
+Local Usage
+===========
+
+Launching the Server
+--------------------
+
+**Step 1: Activate the environment**
+
+.. code-block:: bash
+
+    # On Windows
+    .\env\Scripts\activate
+
+    # On Unix or MacOS
+    source env/bin/activate
+
+**Step 2: Launch the server**
+
+.. code-block:: bash
+
+    python manage.py runserver
+
+Launching Tests
+---------------
+
+**Step 1: Activate the environment**
+
+.. code-block:: bash
+
+    # On Windows
+    .\env\Scripts\activate
+
+    # On Unix or MacOS
+    source env/bin/activate
+
+**Step 2: Navigate to the application**
+
+.. code-block:: bash
+
+    cd ./lettings || cd ./profiles || cd ./oc_lettings_site
+
+**Step 3: Execute the tests**
+
+.. code-block:: bash
+
+    pytest tests.py
+
+**To test all files at once, without leaving the root directory:**
+
+.. code-block:: bash
+
+    pytest --cov
+
+Launching Linting
+-----------------
+
+**Step 1: Activate the environment**
+
+.. code-block:: bash
+
+    # On Windows
+    .\env\Scripts\activate
+
+    # On Unix or MacOS
+    source env/bin/activate
+
+**Step 2: Execute flake8**
+
+.. code-block:: bash
+
+    flake8

doc/_build/html/_sources/presentation.rst.txt

@@ -0,0 +1,31 @@
+Presentation
+========================================
+
+Oc Lettings
+------------
+
+OC Lettings is a django app displaying lettings and profiles to the user and an admin part.
+The project was to refactor the app from oc_lettings_site only to oc_lettings_site, lettings and profile apps.
+The project is tested thanks to all tests.py files and it is deployed to render url when git pull or push on main branch
+and github actions validate the project.
+
+Composition
+------
+
+1. **Django**:
+    - This is a Django project.
+
+2. **Flake8**:
+    - Flake8 was used for linting.
+
+3. **Sentry**:
+    - Sentry provides a log system to avoid error and capture exceptions.
+
+4. **Github Actions**:
+    - Github Actions allows us to test the projec, buld and push the image to docker.
+
+5. **Docker**:
+    - Docker is used to build and push an image to render and allow our ci/cd pipeline to work efficiently.
+
+6. **Render**:
+    - Render get our image and deploy it on a url.

doc/_build/html/_sources/requirements.rst.txt

@@ -0,0 +1,46 @@
+Requirements
+===============================================
+
+Environment Setup
+-----------------
+
+After cloning or forking the repository, you need to set up a virtual environment and install the required packages. Follow these steps:
+
+1. **Create a virtual environment**:
+
+    Depending on your operating system and preference, you can create a virtual environment using `venv` (included in Python 3.3 and later) or any other tool like `virtualenv`.
+
+    For `venv`, run:
+
+    .. code-block:: bash
+
+        python -m venv env
+
+    Activate the environment:
+
+    .. code-block:: bash
+
+        # On Windows
+        .\env\Scripts\activate
+
+        # On Unix or MacOS
+        source env/bin/activate
+
+2. **Install the required packages**:
+
+    Install all dependencies listed in the `requirements.txt` file using pip:
+
+    .. code-block:: bash
+
+        pip install -r requirements.txt
+
+This setup will ensure that all necessary libraries and packages are installed in your virtual environment, keeping your project's dependencies isolated from other Python projects.
+
+Secret Variables
+-----------------
+
+Create a .env file at root, and add these lines with the proper infos :
+    .. code-block:: bash
+        DOCKER_USERNAME="your_docker_username"
+        DOCKER_PASSWORD="your_docker_password"
+        SENTRY_DSN="your_sentry_dsn"

doc/_build/html/_sources/sentry.rst.txt

@@ -0,0 +1,11 @@
+Sentry
+========================================
+
+Sentry is used in the views to check for errors with capture_exceptions
+and tells us about the issue with capture_messages
+
+It is configured inside our settings :
+    .. code-block:: bash
+        sentry_dsn = os.getenv('SENTRY_DSN')
+
+Sentry_DSN is your secret variable in .env file !