refactor endpoints for improved readability and maintenance (#116)

offsets_db_api/cache.py

@@ -4,8 +4,8 @@
 from fastapi import Request, Response
 from fastapi_cache import FastAPICache
 
-from .logging import get_logger
-from .query_helpers import _convert_query_params_to_dict
+from offsets_db_api.log import get_logger
+from offsets_db_api.query_helpers import _convert_query_params_to_dict
 
 logger = get_logger()
 

offsets_db_api/database.py

@@ -2,7 +2,7 @@
 
 from sqlmodel import Session, create_engine
 
-from .settings import get_settings
+from offsets_db_api.settings import get_settings
 
 
 def get_engine(*, database_url: str):

offsets_db_api/main.py

@@ -10,10 +10,10 @@
 from watchdog.events import FileSystemEventHandler
 from watchdog.observers import Observer
 
-from .app_metadata import metadata
-from .cache import clear_cache, request_key_builder, watch_dog_dir, watch_dog_file
-from .logging import get_logger
-from .routers import charts, clips, credits, files, health, projects
+from offsets_db_api.app_metadata import metadata
+from offsets_db_api.cache import clear_cache, request_key_builder, watch_dog_dir, watch_dog_file
+from offsets_db_api.log import get_logger
+from offsets_db_api.routers import charts, clips, credits, files, health, projects
 
 logger = get_logger()
 

offsets_db_api/models.py

@@ -5,7 +5,7 @@
 from sqlalchemy.dialects import postgresql
 from sqlmodel import BigInteger, Column, Field, Relationship, SQLModel, String
 
-from .schemas import FileCategory, FileStatus, Pagination
+from offsets_db_api.schemas import FileCategory, FileStatus, Pagination
 
 
 class File(SQLModel, table=True):
@@ -140,12 +140,12 @@ class CreditWithCategory(CreditBase):
 
 class PaginatedProjects(pydantic.BaseModel):
     pagination: Pagination
-    data: list[ProjectWithClips]
+    data: list[ProjectWithClips] | list[dict[str, typing.Any]]
 
 
 class PaginatedCredits(pydantic.BaseModel):
     pagination: Pagination
-    data: list[CreditWithCategory]
+    data: list[CreditWithCategory] | list[dict[str, typing.Any]]
 
 
 class BinnedValues(pydantic.BaseModel):
@@ -207,3 +207,8 @@ class PaginatedBinnedCreditTotals(pydantic.BaseModel):
 class PaginatedClips(pydantic.BaseModel):
     pagination: Pagination
     data: list[ClipwithProjects] | list[dict[str, typing.Any]]
+
+
+class PaginatedFiles(pydantic.BaseModel):
+    pagination: Pagination
+    data: list[File] | list[dict[str, typing.Any]]

offsets_db_api/query_helpers.py

@@ -6,8 +6,8 @@
 from sqlalchemy.orm import Query
 from sqlmodel import and_, asc, desc, distinct, func, nullslast, or_, select
 
-from .logging import get_logger
-from .models import Clip, ClipProject, Credit, Project
+from offsets_db_api.log import get_logger
+from offsets_db_api.models import Clip, ClipProject, Credit, Project
 
 logger = get_logger()