tubearchivist/backend
Craig Alexander 6b859eb436
Configure git to always use LF (#1013)
2025-07-31 21:29:58 +07:00
..
appsettings handle none page size subscriptions 2025-07-13 16:54:13 +07:00
channel fix unknown vid_type query building 2025-07-17 20:51:59 +07:00
common Configure git to always use LF (#1013) 2025-07-31 21:29:58 +07:00
config fix channel_tabs sync to videos, #build 2025-07-12 23:33:22 +07:00
download fix empty is_live video response handling, #1016 2025-07-23 21:11:55 +07:00
playlist fix type 2025-07-12 22:41:08 +07:00
stats fix WatchStatsSerializer null value 2025-02-14 15:40:50 +07:00
task add to each item to pending queue in loop 2025-07-11 22:47:28 +07:00
user Add video details view (#956) 2025-06-05 10:19:16 +07:00
video remove unused vid thumb blur 2025-07-12 18:18:22 +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 bump requirements 2025-07-22 17:36:35 +07:00
requirements.txt bump requirements 2025-07-22 17:36:35 +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