Added dockstrings

.github/workflows/config.yml

@@ -0,0 +1,32 @@
+name: Django CI/CD
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    env:
+      MODE: ${{ secrets.MODE }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run Tests
+        run: |
+          python manage.py test

.gitignore

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

home/admin.py

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

home/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class HomeConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'home'
+    test_module = 'home.tests'

home/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

home/tests/test_view.py

@@ -0,0 +1,38 @@
+from django.test import TestCase
+from django.urls import reverse
+from django.http import HttpRequest
+
+from home.views import index
+
+
+class TestIndexView(TestCase):
+    def _extracted_from_test_returns_200_status_code_for_get_request_3(self):
+        url = reverse('home:index')
+        request = HttpRequest()
+        return self.client.get(url)
+
+    #  Returns a 200 status code for a GET request
+    def test_handles_get_requests(self):
+        # Arrange
+        from django.shortcuts import render
+        request = type('Request', (), {})()
+
+        # Act
+        response = index(request)
+
+        # Assert
+        assert response.status_code == 200
+
+    def test_handles_post_requests(self):
+        # Arrange
+        from django.shortcuts import render
+        request = type('Request', (), {})()
+        request.method = 'POST'
+
+        # Act
+        response = index(request)
+
+        # Assert
+        assert response.status_code == 200
+
+    #  Renders the 'home/index.html' template for a GET request

home/urls.py

@@ -0,0 +1,7 @@
+from django.urls import path
+from . import views
+
+urlpatterns = [
+    path('', views.index, name='index'),
+
+]

home/views.py

@@ -0,0 +1,5 @@
+from django.shortcuts import render
+
+
+def index(request):
+    return render(request, 'home/index.html')

lettings/admin.py

@@ -0,0 +1,8 @@
+from django.contrib import admin
+from .models import Letting  # Importez le modèle Letting de l'application lettings
+from .models import Address
+
+
+admin.site.register(Letting)  # Enregistrez le modèle Letting dans l'interface d'administration
+
+admin.site.register(Address)

lettings/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class LettingsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'lettings'
+    test_module = 'lettings.tests'

lettings/migrations/0001_initial.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.2.7 on 2023-11-07 12:41
+
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Address',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('number', models.PositiveIntegerField(validators=[django.core.validators.MaxValueValidator(9999)])),
+                ('street', models.CharField(max_length=64)),
+                ('city', models.CharField(max_length=64)),
+                ('state', models.CharField(max_length=2, validators=[django.core.validators.MinLengthValidator(2)])),
+                ('zip_code', models.PositiveIntegerField(validators=[django.core.validators.MaxValueValidator(99999)])),
+                ('country_iso_code', models.CharField(max_length=3, validators=[django.core.validators.MinLengthValidator(3)])),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Letting',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(max_length=256)),
+                ('address', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to='lettings.address')),
+            ],
+        ),
+    ]

lettings/migrations/0002_alter_letting_address.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.2.7 on 2023-11-08 13:53
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('lettings', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='letting',
+            name='address',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='lettings.address'),
+        ),
+    ]

lettings/models.py

@@ -0,0 +1,62 @@
+from django.db import models
+from django.core.validators import MaxValueValidator, MinLengthValidator
+
+
+class Address(models.Model):
+    """
+    Model representing an address.
+
+    Attributes:
+        number (PositiveIntegerField): The number of the address.
+        street (CharField): The street of the address.
+        city (CharField): The city of the address.
+        state (CharField): The state of the address.
+        zip_code (PositiveIntegerField): The zip code of the address.
+        country_iso_code (CharField): The ISO code of the country.
+
+    Methods:
+        __str__: Returns a string representation of the address.
+    """
+
+    number = models.PositiveIntegerField(validators=[MaxValueValidator(9999)])
+    street = models.CharField(max_length=64)
+    city = models.CharField(max_length=64)
+    state = models.CharField(max_length=2, validators=[MinLengthValidator(2)])
+    zip_code = models.PositiveIntegerField(validators=[MaxValueValidator(99999)])
+    country_iso_code = models.CharField(max_length=3, validators=[MinLengthValidator(3)])
+
+    def __str__(self):
+        """
+        Return a string representation of the object.
+
+        Returns:
+            str: The string representation of the object.
+        """
+
+        return f'{self.number} {self.street}'
+
+
+class Letting(models.Model):
+    """
+    Model representing a letting.
+
+    Attributes:
+        title (CharField): The title of the letting.
+        address (ForeignKey): The address associated with the letting.
+
+    Methods:
+        __str__: Returns a string representation of the letting.
+    """
+
+    title = models.CharField(max_length=256)
+    address = models.ForeignKey(Address, on_delete=models.CASCADE)
+
+    def __str__(self):
+        """
+        Return a string representation of the object.
+
+        Returns:
+            str: The string representation of the object.
+        """
+
+        return self.title