Добавлено описание проекта

Author: experiment0

Makefile

@@ -17,10 +17,19 @@ fix:
 test:
 	uv run pytest
 
-# Проверяет покрытие кода тестами и формирует отчет в файле coverage.xml
-# Далее этот файл использует SonarCloud для анализа
+
+# Команда проверяет покрытие кода тестами и выводит отчет в консоли.
+# Примечание.
+# Данный проект тестируется с помощью воркфлоу .github\workflows\hexlet-check.yml,
+# где задействован фреймворк playwright для браузерного тестирования.
+# Браузерное тестирование подходит для данного проекта лучше, чем подмена зависимостей для
+# приложения flask и базы данных.
+# Т.к. браузерное тестирование для данного случая более соответствует принципу 
+# тестирования "черного ящика".
+# Поэтому доп. тесты в данном приложении реализованы минимально.
 test-coverage:
-	uv run pytest --cov=page_analyzer --cov-report xml
+	uv run pytest --cov=page_analyzer
+
 
 # Прогоняет сначала тесты, потом проверку линтером
 check: test lint

README.md

@@ -12,7 +12,6 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=bugs)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=coverage)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
 [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
 [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=experiment0_python-project-83&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=experiment0_python-project-83)
@@ -23,27 +22,36 @@
 
 ## О проекте
 
-> Проект находится в стадии реализации.
+Данный проект создан в процессе прохождения курса [Python-разработчик](https://ru.hexlet.io/programs/python).\
+В нем реализовано web-приложение на Flask для проверки доступности сайтов и анализа заполнения тегов, значимых для SEO.
 
 ## Демонстрация работы
 
-Проект развернут на платформе `render.com`: \
+Проект развернут на платформе [render.com](https://render.com/) и доступен по ссылке: \
 https://python-project-83-jgqi.onrender.com/
 
+> **Примечание.** \
+Поскольку для деплоя сайта используется бесплатный тариф, \
+платформа `render.com` утилизует ресурсы, которые не используются какое-то время.\
+Поэтому при открытии сайта, возможно, загрузка сайта начнется с процесса его сборки \
+и нужно будет подождать ее окончания.\
+Также на `render.com`  довольно нестабильное соединение с БД.\
+В случае появления ошибок, нужно обновить страницу.
+
+[Видео с демо работы сайта](https://disk.yandex.ru/i/j4X0FTNm-kY-CA)
+
 ## Инструкция по локальному запуску
 
 1. Проверить, установлена ли утилита `uv`:
     ```sh
     uv --version
     ```
-
     Если не установлена, то нужно установить [по инструкции](https://docs.astral.sh/uv/getting-started/installation/#installation-methods).
 
 2. Проверить, установлена ли утилита `make`:
     ```sh
     make --version
     ```
-
     Если не установлена, то установить [на windows](https://stackoverflow.com/questions/32127524/how-can-i-install-and-use-make-in-windows) или [на ubuntu](https://andreyex.ru/ubuntu/kak-ustanovit-make-na-ubuntu/).
 
 3. 
@@ -56,9 +64,19 @@ https://python-project-83-jgqi.onrender.com/
 
     # Установить зависимости
     make install
+    ```
 
+4. Создать в корне проекта файл `.env` для переменных среды.
+    ```sh
+    touch .env
+    ```
+    И добавить в него переменные среды по аналогии с образцом из файла [.env-example](./.env-example) \
+    В переменной `DATABASE_URL` указывается путь для соединения с БД PostgreSQL. \
+    Если она не установлена, ее нужно установить [по инструкции](https://tproger.ru/articles/osnovy-postgresql-dlya-nachinayushhih--ot-ustanovki-do-pervyh-zaprosov-250851).
+
+5.
+    ```sh
     # Запустить локальный сервер
     make dev
-   ```
-   
-   Перейти по ссылке http://127.0.0.1:5000
+    ```  
+    Перейти по ссылке http://127.0.0.1:5000

database.sql

@@ -1,5 +1,5 @@
-DROP TABLE IF EXISTS urls;
 DROP TABLE IF EXISTS url_checks;
+DROP TABLE IF EXISTS urls;
 
 CREATE TABLE urls (
     id SERIAL PRIMARY KEY,

page_analyzer/app.py

@@ -111,7 +111,7 @@ def urls_post():
         return render_template(ERROR_TEMPLATE), 422
 
 
-@app.route("/urls/<id>")
+@app.route("/urls/<int:id>")
 def urls_show(id):
     url_data = urls_model.find_by_id(id)
 
@@ -130,7 +130,7 @@ def urls_show(id):
     )
 
 
-@app.post("/urls/<id>/checks")
+@app.post("/urls/<int:id>/checks")
 def urls_checks_post(id):
     url_data = urls_model.find_by_id(id)
 

page_analyzer/models/MixedModel.py

@@ -42,6 +42,9 @@ def get_last_url_checks(self) -> list[LastUrlCheck]:
 
         try:
             with conn.cursor(cursor_factory=RealDictCursor) as cursor:
+                # В данном запросе нужно расположить новые записи выше.
+                # Поскольку id записи в общем случае не должен соответствовать 
+                # порядку записей, то сортируем их по времени добавления.
                 cursor.execute(
                     """SELECT url_id, name, status_code, created_at FROM (
                             SELECT 

tests/conftest.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+
 import pytest
 
 

tests/test_app.py

@@ -0,0 +1,30 @@
+import pytest
+
+from page_analyzer import app
+
+
+@pytest.fixture
+def client():
+    app.config["TESTING"] = True
+    client = app.test_client()
+
+    yield client
+
+
+def test_index_route(client):
+    response = client.get("/")
+    html = response.data.decode()
+
+    assert response.status_code == 200
+    assert '<h1 class="display-3">Анализатор страниц</h1>' in html
+    assert \
+        '<label for="text" class="visually-hidden">Url для проверки</label>' \
+        in html
+
+
+def test_404(client):
+    response = client.get("/not_found_page")
+    html = response.data.decode()
+
+    assert response.status_code == 404
+    assert "<h1>Страница не найдена</h1>" in html