Render changelog

Author: koldakov

futuramaapi/helpers/__init__.py

@@ -0,0 +1,5 @@
+from ._markdown import render_markdown
+
+__all__ = [
+    "render_markdown",
+]

futuramaapi/helpers/_markdown.py

@@ -0,0 +1,53 @@
+import bleach
+import markdown
+
+ALLOWED_TAGS = bleach.sanitizer.ALLOWED_TAGS | {
+    "h1",
+    "h2",
+    "h3",
+    "h4",
+    "p",
+    "pre",
+    "code",
+    "ul",
+    "ol",
+    "li",
+    "strong",
+    "em",
+    "blockquote",
+    "hr",
+    "a",
+}
+
+ALLOWED_ATTRIBUTES = {
+    "a": [
+        "href",
+        "title",
+    ],
+}
+
+ALLOWED_PROTOCOLS = {
+    "http",
+    "https",
+    "mailto",
+}
+
+
+def render_markdown(md: str, /) -> str:
+    html = markdown.markdown(
+        md,
+        extensions=[
+            "extra",
+            "fenced_code",
+            "toc",
+        ],
+        output_format="html",
+    )
+
+    return bleach.clean(
+        html,
+        tags=ALLOWED_TAGS,
+        attributes=ALLOWED_ATTRIBUTES,
+        protocols=ALLOWED_PROTOCOLS,
+        strip=True,
+    )

futuramaapi/routers/rest/root/api.py

@@ -11,7 +11,7 @@
 from futuramaapi.routers.rest.users.dependencies import cookie_user_from_form_data, user_from_cookies
 from futuramaapi.routers.rest.users.schemas import Link, User
 
-from .schemas import About, Root, SiteMap, UserAuth
+from .schemas import About, Changelog, Root, SiteMap, UserAuth
 
 router = APIRouter()
 
@@ -189,3 +189,16 @@ async def get_sitemap(
 ) -> Response:
     obj: SiteMap = await SiteMap.from_request(request)
     return await obj.get_response()
+
+
+@router.get(
+    "/changelog",
+    include_in_schema=False,
+    name="changelog",
+)
+async def get_changelog(
+    request: Request,
+    session: AsyncSession = Depends(get_async_session),  # noqa: B008
+):
+    obj: Changelog = await Changelog.from_request(session, request)
+    return await obj.get_response(request)

futuramaapi/routers/rest/root/schemas.py

@@ -1,13 +1,17 @@
 from datetime import UTC, datetime, timedelta
+from pathlib import Path
 from typing import TYPE_CHECKING, ClassVar, Self
 
+import aiofiles
+from aiocache import Cache, cached
 from fastapi import Response
 from pydantic import HttpUrl
 from sqlalchemy import Select, select
 from sqlalchemy.ext.asyncio import AsyncSession
 from starlette.requests import Request
 
 from futuramaapi.core import settings
+from futuramaapi.helpers import render_markdown
 from futuramaapi.helpers.pydantic import BaseModel, Field
 from futuramaapi.mixins.pydantic import BaseModelTemplateMixin, ProjectContext
 from futuramaapi.repositories import FilterStatementKwargs
@@ -106,3 +110,26 @@ async def from_request(cls, request: Request) -> Self:
         return cls(
             urls=[url.path for url in app.public_urls],
         )
+
+
+@cached(
+    ttl=None,
+    cache=Cache.MEMORY,
+)
+async def _get_rendered_content() -> str:
+    path: Path = Path(settings.project_root) / "CHANGELOG.md"
+    async with aiofiles.open(path, encoding="utf-8") as f:
+        raw_content = await f.read()
+    return render_markdown(raw_content)
+
+
+class Changelog(BaseModel, BaseModelTemplateMixin):
+    content: str
+
+    template_name: ClassVar[str] = "changelog.html"
+
+    @classmethod
+    async def from_request(cls, session: AsyncSession, request: Request, /) -> Self:
+        return cls(
+            content=await _get_rendered_content(),
+        )

poetry.lock

@@ -41,6 +41,9 @@ redis = "^7.1.0"
 pydantic = "^2.12.5"
 alembic = "^1.17.2"
 strawberry-graphql = "^0.288.2"
+markdown = "^3.10"
+bleach = "^6.3.0"
+aiofiles = "^25.1.0"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^4.5.1"

pyproject.toml

@@ -116,6 +116,17 @@ <h3>Hi, {{ current_user.full_name }}, welcome to</h3>
         <div
           class="col-lg-6 mx-auto"
         >
+          <div
+            class="d-flex justify-content-center"
+          >
+            <a
+              href="{{ relative_path_for('changelog') }}"
+              class="btn btn-info"
+              role="button"
+              target="_blank"
+            >Changelog
+            </a>
+          </div>
           <div
             class="d-grid d-sm-flex justify-content-sm-center mb-5"
           >

static/css/changelog.css

@@ -0,0 +1,30 @@
+{% extends "base.html" %}
+
+{% set active_page = "changelog" %}
+
+{% block title %}Changelog{% endblock %} | Futurama API
+
+{% block extra_styles %}
+  <link
+    href="{{ relative_path_for('static', path='/css/changelog.css') }}"
+    rel="stylesheet"
+  />
+{% endblock %}
+
+{% block main_info %}{% endblock %}
+
+{% block main_content %}
+<div
+  class="container my-5"
+>
+  <div
+    class="row justify-content-center"
+  >
+    <div
+      class="col-lg-9 col-xl-8 changelog"
+    >
+      {{ content | safe }}
+    </div>
+  </div>
+</div>
+{% endblock %}