tubearchivist/backend
Simon b2b25f24ed
serialize stats
2025-02-11 21:32:42 +07:00
..
appsettings add common view serializers 2025-02-10 21:42:46 +07:00
channel add appsettings serializers and docs 2025-02-09 22:10:29 +07:00
common add common view serializers 2025-02-10 21:42:46 +07:00
config add drf_spectacular, type and serialize channel app 2025-02-09 17:41:12 +07:00
download document and serialize download views 2025-02-10 18:29:50 +07:00
playlist serialize playlists, add custom playlist endpoints 2025-02-11 19:22:39 +07:00
stats serialize stats 2025-02-11 21:32:42 +07:00
task parse unix connection string for redis socket 2025-01-27 16:36:19 +07:00
user add show helptext user config value 2025-01-26 16:18:45 +07:00
video fix progress inconsistency+ 2025-02-02 16:30:43 +07:00
README.md add django app overview readme 2024-08-10 16:12:06 +02:00
manage.py renamed django app folder to backend 2024-08-03 21:58:22 +02:00
requirements-dev.txt add drf_spectacular, type and serialize channel app 2025-02-09 17:41:12 +07:00
requirements.txt add drf_spectacular, type and serialize channel app 2025-02-09 17:41:12 +07:00

README.md

Django Setup

Apps

The backend is split up into the following apps.

config

Root Django App. Doesn't define any views.

  • Has main settings.py
  • Has main urls.py responsible for routing to other apps

common

Functionality shared between apps.

Defines views on the root /api/* path. Has base views to inherit from.

  • Connections to ES and Redis
  • Searching
  • URL parser
  • Collection of helper functions

appsettings

Responsible for functionality from the settings pages.

Defines views at /api/appsettings/*.

  • Index setup
  • Reindexing
  • Snapshots
  • Filesystem Scan
  • Manual import

channel

Responsible for Channel Indexing functionality.

Defines views at /api/channel/* path.

download

Implements download functionality with yt-dlp.

Defines views at /api/download/*.

  • Download videos
  • Queue management
  • Thumbnails
  • Subscriptions

playlist

Implements playlist functionality.

Defines views at /api/playlist/*.

  • Index Playlists
  • Manual Playlists

stats

Builds aggregations views for the statistics dashboard.

Defines views at /api/stats/*.

task

Defines tasks for Celery.

Defines views at /api/task/*.

  • Has main tasks.py with all shared_task definitions
  • Has CustomPeriodicTask model
  • Implements apprise notifications links
  • Implements schedule functionality

user

Implements user and auth functionality.

Defines views at /api/config/*.

  • Defines custom Account model

video

Index functionality for videos.

Defines views at /api/video/*.

  • Index videos
  • Index comments
  • Index/download subtitles
  • Media stream parsing