tubearchivist/backend
Simon 8f34626a27
bump TA_VERSION
2025-03-27 21:40:00 +01:00
..
appsettings AdminWriteOnly /appsettings/config (#892) 2025-03-15 20:13:48 +07:00
channel delay playlist extraction 2025-03-27 21:13:13 +01:00
common add health API endpoint, #887 2025-03-11 22:12:32 +07:00
config bump TA_VERSION 2025-03-27 21:40:00 +01:00
download add delete and ignore, #891 2025-03-15 13:50:26 +01:00
playlist add page serializer 2025-02-20 16:41:18 +07:00
stats fix WatchStatsSerializer null value 2025-02-14 15:40:50 +07:00
task fix backend tasks messages notification types 2025-03-24 21:59:35 +01:00
user backend: store file_size_unit in user config, #886 2025-03-15 13:59:49 +01:00
video clean logs 2025-02-21 23:31:45 +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 dependencies 2025-03-26 07:45:28 +01:00
requirements.txt bump dependencies 2025-03-26 07:45:28 +01: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