Merge pull request #12 from ae-utbm/news

Automaticaly post news

Author: imperosol

.pre-commit-config.yaml

@@ -1,10 +1,16 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [ "--fix=lf" ]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.11.4
+    rev: v0.14.0
     hooks:
-      - id: ruff  # just check the code, and print the errors
-      - id: ruff  # actually fix the fixable errors, but print nothing
-        args: ["--fix", "--silent"]
+      - id: ruff-check  # just check the code, and print the errors
+      - id: ruff-check  # actually fix the fixable errors, but print nothing
+        args: [ "--fix", "--silent" ]
       # Run the formatter.
       - id: ruff-format

Dockerfile

@@ -14,4 +14,4 @@ WORKDIR /app
 RUN --mount=type=cache,target=/root/.cache/uv \
     uv sync --locked --compile-bytecode
 
-ENTRYPOINT ["uv", "run", "-m", "src.main"]
+ENTRYPOINT ["uv", "run", "-m", "src.main"]

README.md

@@ -36,4 +36,4 @@ Pour lancer le bot :
 
 ```shell
 uv run -m src.main
-```
+```

bot.toml.example

@@ -1,10 +1,12 @@
-[bot]
-token = "<your discord bot token here>"
-log_level = "INFO"
-
-[guild]
-id = <the id of the server here>
-
-[sith_api]
-api_key = "<your sith api token here>"
-url = "https://ae.utbm.fr/"
+[bot]
+token = "<your discord bot token here>"
+log_level = "INFO"
+
+[guild]
+id = <the id of the server here>
+news_channel_id = <the id of the news channel here>
+news_role_id = <the id of the news channel here>
+
+[sith_api]
+api_key = "<your sith api token here>"
+url = "https://ae.utbm.fr/"

pyproject.toml

@@ -9,6 +9,7 @@ dependencies = [
     "discord-py[speed]>=2.6.4",
     "pydantic-settings>=2.11.0",
     "pydantic>=2.12.0",
+    "pytz>=2025.2",
 ]
 
 [dependency-groups]

src/client.py

@@ -1,7 +1,7 @@
 import asyncio
 import logging
 import types
-from datetime import date
+from datetime import date, datetime
 
 from aiohttp import (
     ClientSession,
@@ -44,11 +44,37 @@ class SimpleClubSchema(BaseModel):
     name: str
 
 
+class ClubProfileSchema(SimpleClubSchema):
+    logo: str | None = None
+    url: str
+
+
 class ClubSearchResultSchema(BaseModel):
     count: int
     results: list[SimpleClubSchema]
 
 
+class NewsSchema(BaseModel):
+    id: int
+    title: str
+    summary: str
+    is_published: bool
+    club: ClubProfileSchema
+    url: str
+
+
+class NewsDateSchema(BaseModel):
+    id: int
+    start_date: datetime
+    end_date: datetime
+    news: NewsSchema
+
+
+class NewsDateResultSchema(BaseModel):
+    count: int
+    results: list[NewsDateSchema]
+
+
 class SithClient(ClientSession):
     def __init__(self):
         self.logger = logging.getLogger("sith")
@@ -83,6 +109,21 @@ async def search_clubs(self, search: str) -> list[SimpleClubSchema] | None:
         except ValidationError as e:
             self.logger.error(str(e))
 
+    async def search_news(
+        self, after: datetime | None = None, before: datetime | None = None
+    ) -> list[NewsDateSchema] | None:
+        params = {"is_published": "true"}
+        if after:
+            params["after"] = after.isoformat()
+        if before:
+            params["before"] = before.isoformat()
+        async with self.get("/api/news/date", params=params) as res:
+            content = await res.read()
+        try:
+            return NewsDateResultSchema.model_validate_json(content).results
+        except ValidationError as e:
+            self.logger.error(str(e))
+
 
 async def request_logging_start(
     _session: SithClient,

src/commands/club.py

@@ -12,7 +12,6 @@
 from src.settings import Settings
 
 if TYPE_CHECKING:
-    from src.client import SithClient
     from src.main import AeBot
 
 
@@ -27,8 +26,8 @@ async def transform(
 
 
 class ClubCog(commands.GroupCog, group_name="club"):
-    def __init__(self, client: SithClient, bot: AeBot):
-        self.club_service = ClubService(client, bot)
+    def __init__(self, bot: AeBot):
+        self.club_service = ClubService(bot)
         self.settings = Settings()
 
     async def autocomplete_club(

src/commands/news.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import datetime
+from typing import TYPE_CHECKING
+
+import pytz
+from discord.ext import commands, tasks
+
+from src.services.news import NewsService
+
+if TYPE_CHECKING:
+    from discord import Role, TextChannel
+
+    from src.main import AeBot
+
+
+class NewsCog(commands.Cog):
+    news_channel: TextChannel
+    news_role: Role
+
+    def __init__(self, bot: AeBot):
+        self.bot = bot
+        self.news_service = NewsService(bot)
+
+    @commands.Cog.listener(name="on_ready")
+    async def on_ready(self):
+        news_channel_id = self.bot.settings.guild.news_channel_id
+        news_role_id = self.bot.settings.guild.news_role_id
+        if not news_channel_id:
+            # If no news channel id is given in the config,
+            # the feature of automatic news post is disabled.
+            return
+        self.news_channel = self.bot.get_channel(news_channel_id)
+        self.news_role = self.bot.watched_guild.get_role(news_role_id)
+        await self.bot.wait_until_ready()
+        self.post_news.start()
+
+    @tasks.loop(
+        time=datetime.time(hour=9, minute=30, tzinfo=pytz.timezone("Europe/Paris"))
+    )
+    async def post_news(self):
+        news_dates = await self.news_service.get_upcoming_news()
+        if not news_dates:
+            return
+        embeds = [self.news_service.embed(n.news) for n in news_dates]
+        content = "## Événements dans les prochains jours"
+        if self.news_role:
+            content += f"\n{self.news_role.mention}"
+        await self.news_channel.send(content, embeds=embeds)

src/main.py

@@ -14,6 +14,7 @@
 from src.commands.admin import AdminCog
 from src.commands.club import ClubCog
 from src.commands.misc import MiscCog
+from src.commands.news import NewsCog
 from src.settings import BASE_DIR, Settings
 
 if TYPE_CHECKING:
@@ -33,7 +34,8 @@ def __init__(self, client: SithClient):
         )
 
     async def setup_hook(self):
-        await self.add_cog(ClubCog(self.client, self))
+        await self.add_cog(ClubCog(self))
+        await self.add_cog(NewsCog(self))
         await self.add_cog(AdminCog(self))
         await self.add_cog(MiscCog())
 

src/services/club.py

@@ -12,7 +12,7 @@
 if TYPE_CHECKING:
     from discord import Guild, Member
 
-    from src.client import ClubSchema, SimpleClubSchema, SithClient
+    from src.client import ClubSchema, SimpleClubSchema
     from src.main import AeBot
 
 
@@ -51,9 +51,9 @@ def save(self):
 class ClubService:
     """Manage features directly related to clubs."""
 
-    def __init__(self, client: SithClient, bot: AeBot):
+    def __init__(self, bot: AeBot):
         self._config = Settings()
-        self._client = client
+        self._client = bot.client
         self._club_cache = {}
         self._bot = bot