Test/oral2

.flake8

@@ -0,0 +1,17 @@
+[flake8]
+ignore = E501,E241,E111,E117,E402,F401,E303,E305,E722,E402
+
+exclude =
+    .git,
+    __pycache__,
+    venv\,
+    .github\
+    .pytest_cache\
+    *.pyc,
+    .env\,
+    env\,
+    venv\,
+    .coverage,
+    templates\,
+    static\,
+

.github/workflows/docker-compose.yml

@@ -0,0 +1,82 @@
+name: GitHub Actions Demo
+run-name: ${{ github.actor }} CI for oc-lettings-site 🚀
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+      DEBUG: "False"
+      ALLOWED_HOSTS: "127.0.0.1,localhost,0.0.0.0,oc-lettings-site-latest-05t2.onrender.com"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run Tests
+        run: |
+          pytest --cov --cov-fail-under=80
+
+  flake8:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run Flake8
+        run: |
+          flake8 --count
+
+  build:
+    needs: [test, flake8]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to DockerHub
+        run: echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" --password-stdin
+
+      - name: Build the Docker image
+        env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+        run: |
+          docker build . --file Dockerfile \
+          --build-arg SECRET_KEY="${SECRET_KEY}" \
+          --tag ${{ secrets.DOCKERHUB_USERNAME }}/oc-lettings-site:${{ github.sha }} \
+          --tag ${{ secrets.DOCKERHUB_USERNAME }}/oc-lettings-site:latest
+
+      - name: Push image to DockerHub
+        run: |
+          docker push ${{ secrets.DOCKERHUB_USERNAME }}/oc-lettings-site:${{ github.sha }}
+          docker push ${{ secrets.DOCKERHUB_USERNAME }}/oc-lettings-site:latest
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+
+    steps:
+      - name: Deploy to Render
+        env:
+          deploy_url: ${{ secrets.RENDER_DEPLOY_HOOK_URL }}
+        run: |
+          curl "$deploy_url"

.gitignore

@@ -1,3 +1,13 @@
 **/__pycache__
 *.pyc
 venv
+.coverage
+venv/
+.env
+staticfiles/
+reports/
+.pytest_cache/
+Dockerfile1
+Dockerfile1
+docker-compose.yml.old
+compose.yml

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# 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.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# 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,22 @@
+FROM python:3.11-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+ARG SECRET_KEY="temporary-insecure-key-for-local-build-only-do-not-use-in-production"
+ENV SECRET_KEY=${SECRET_KEY}
+
+COPY . .
+
+RUN python manage.py makemigrations --noinput && \
+    python manage.py migrate --noinput
+
+RUN python manage.py collectstatic --noinput
+
+EXPOSE 8000
+
+CMD ["gunicorn", "oc_lettings_site.wsgi:application", "--bind", "0.0.0.0:8000"]

compose.yml

@@ -0,0 +1,25 @@
+version: "3.13"
+
+services:
+  quality-check:
+    build: .
+    volumes:
+      - .:/app
+    working_dir: /app
+    entrypoint: ["/bin/sh", "-c"]
+    command: >
+      flake8 . --count --max-complexity=10 --max-line-length=88 --exclude=venv,migrations,__pycache__ &&
+      pytest --cov=. --cov-report=term-missing --cov-fail-under=80
+
+  web:
+    build: .
+    command: gunicorn oc_lettings_site.wsgi:application --bind 0.0.0.0:8000 --reload
+    ports:
+      - "8000:8000"
+    env_file:
+      - .env
+    volumes:
+      - .:/app
+    depends_on:
+      quality-check:
+        condition: service_completed_successfully

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     = .
+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/api_reference.rst

@@ -0,0 +1,53 @@
+Code Reference
+=============
+
+This section documents all classes, functions, and methods available in the OC Lettings Site application.
+
+Lettings Application
+--------------------
+
+The lettings app manages rental properties and their addresses.
+
+Models
+~~~~~~
+
+.. autoclass:: lettings.models.Address
+   :members:
+   :exclude-members: DoesNotExist, MultipleObjectsReturned, objects, id, pk, letting
+
+.. autoclass:: lettings.models.Letting
+   :members:
+   :exclude-members: DoesNotExist, MultipleObjectsReturned, objects, id, pk, address_id
+
+Views
+~~~~~
+
+.. automodule:: lettings.views
+   :members:
+
+Profiles Application
+--------------------
+
+The profiles app manages user profiles with additional information.
+
+Models
+~~~~~~
+
+.. autoclass:: profiles.models.Profile
+   :members:
+   :exclude-members: DoesNotExist, MultipleObjectsReturned, objects, id, pk, user_id
+
+Views
+~~~~~
+
+.. automodule:: profiles.views
+   :members:
+
+Main Site (oc_lettings_site)
+---------
+
+Views
+~~~~~
+
+.. automodule:: oc_lettings_site.views
+   :members: