tubearchivist/backend
Simon cd55ae87fa
remove old channel_indexed mig
2025-12-28 10:47:26 +07:00
..
appsettings use embedded for manual import, add error control 2025-12-26 21:29:23 +07:00
channel add test_zero_config_overwrite 2025-09-27 19:53:56 +07:00
common parse timestamp as str 2025-12-15 21:16:16 +07:00
config remove old channel_indexed mig 2025-12-28 10:47:26 +07:00
download fix None playlist overwrite indexing 2025-12-28 08:50:05 +07:00
playlist fix playlist description none data type 2025-12-28 10:44:57 +07:00
stats limit log to debug only 2025-11-15 11:08:33 +07:00
task use embedded for manual import, add error control 2025-12-26 21:29:23 +07:00
user increase default page_size for user 2025-12-28 09:47:31 +07:00
video fix restore_artwork call, create folders 2025-12-28 09:42:46 +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.txt downgrade drf spectacular 2025-12-15 20:59:15 +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