initial commit for announcements module

Author: gunmack

src/announcements/crud.py

@@ -0,0 +1,20 @@
+import logging
+from datetime import date, datetime
+
+import sqlalchemy
+from sqlalchemy import func
+
+import database
+from announcements.models import Announcements
+
+async def create_new_entry(
+    db_session: database.DBSession,
+    title: str,
+    content: str,
+    computing_id: str,
+    date_created: date,
+):
+    """To create a new announcement entry"""
+
+    # TODO: Implement the logic to create a new announcement entry in the database
+    pass

src/announcements/tables.py

@@ -0,0 +1,18 @@
+from sqlalchemy import Column, VARCHAR, INTEGER, DATETIME, ForeignKey
+
+from constants import COMPUTING_ID_LEN
+from database import Base
+from officers import tables
+
+class Announcement(Base):
+    __tablename__ = "announcements"
+
+    aid = Column(INTEGER, primary_key=True, autoincrement=True)
+    title = Column(VARCHAR(128), nullable=False)
+    content = Column(VARCHAR(256), nullable=False)
+    date_created = Column(DATETIME(timezone=True), nullable=False)
+    computing_id = Column(
+        VARCHAR(COMPUTING_ID_LEN),
+        ForeignKey("officer_info.computing_id"),
+        nullable=False,
+    )

src/announcements/url.py

@@ -0,0 +1,23 @@
+import logging
+
+from fastapi import APIRouter, Request, HTTPException, status
+import fastapi.responses import JSONResponse
+
+import auth
+import announcements.crud   
+import database
+from permission.types import OfficerPrivateInfo
+
+_logger = logging.getLogger(__name__)
+
+router =  APIRouter(
+    prefix="/announcements",
+    tags=["announcements"],
+)
+
+@router.get("",
+            response_class=JSONResponse,
+    status_code=status.HTTP_200_OK,
+)
+async def get_announcements(request: Request):
+    return {"message": "This is the announcements endpoint."}