update doc strings to represent new module structure

tubearchivist/api/views.py

@@ -1,9 +1,9 @@
 """all API views"""
 
 import requests
+from home.src.download.thumbnails import ThumbManager
 from home.src.ta.config import AppConfig
 from home.src.ta.helper import UrlListParser
-from home.src.download.thumbnails import ThumbManager
 from home.tasks import extrac_dl, subscribe_to
 from rest_framework.authentication import (
     SessionAuthentication,

tubearchivist/home/src/download/queue.py

@@ -1,4 +1,8 @@
-"""handle download queue"""
+"""
+Functionality:
+- handle download queue
+- linked with ta_dowload index
+"""
 
 import json
 import os

tubearchivist/home/src/download/subscriptions.py

@@ -1,4 +1,8 @@
-"""handle subscriptions"""
+"""
+Functionality:
+- handle channel subscriptions
+- handle playlist subscriptions
+"""
 
 import yt_dlp
 from home.src.download import queue  # partial import

tubearchivist/home/src/download/thumbnails.py

@@ -1,6 +1,7 @@
 """
 functionality:
 - handle download and caching for thumbnails
+- check for missing thumbnails
 """
 
 import os

tubearchivist/home/src/download/yt_dlp_handler.py

@@ -1,4 +1,10 @@
-"""handle yt_dlp downloads"""
+"""
+functionality:
+- handle yt_dlp
+- build options and post processor
+- download video files
+- move to archive
+"""
 
 import os
 import shutil

tubearchivist/home/src/es/connect.py

@@ -1,4 +1,8 @@
-"""holds es connection manager"""
+"""
+functionality:
+- wrapper around requests to call elastic search
+- reusable search_after to extract total index
+"""
 
 import json
 

tubearchivist/home/src/es/index_setup.py

@@ -1,4 +1,9 @@
-"""setup and verify needed elastic indexes"""
+"""
+functionality:
+- setup elastic index at first start
+- verify and update index mapping and settings if needed
+- backup and restore metadata
+"""
 
 import json
 import os

tubearchivist/home/src/frontend/watched.py

@@ -1,4 +1,7 @@
-"""handle watch state"""
+"""
+functionality:
+- handle watched state for videos, channels and playlists
+"""
 
 import json
 from datetime import datetime

tubearchivist/home/src/index/channel.py

@@ -1,4 +1,8 @@
-"""handle single channel in index"""
+"""
+functionality:
+- get metadata from youtube for a channel
+- index and update in es
+"""
 
 import json
 import os

tubearchivist/home/src/index/generic.py

@@ -1,4 +1,7 @@
-"""generic base class for indexing documents"""
+"""
+functionality:
+- generic base class to inherit from for video, channel and playlist
+"""
 
 import math
 

tubearchivist/home/src/index/playlist.py

@@ -1,4 +1,8 @@
-"""handle playlist"""
+"""
+functionality:
+- get metadata from youtube for a playlist
+- index and update in es
+"""
 
 import json
 from datetime import datetime

tubearchivist/home/src/index/reindex.py

@@ -1,4 +1,8 @@
-"""periodically refresh documents"""
+"""
+functionality:
+- periodically refresh documents
+- index and update in es
+"""
 
 import json
 from datetime import datetime

tubearchivist/home/src/index/video.py

@@ -1,4 +1,8 @@
-"""handle single video index"""
+"""
+functionality:
+- get metadata from youtube for a video
+- index and update in es
+"""
 
 import os
 from datetime import datetime

tubearchivist/home/src/ta/config.py

@@ -2,7 +2,6 @@
 Functionality:
 - read and write config
 - load config variables into redis
-- needs to be a separate module to avoid circular import
 """
 
 import json

tubearchivist/home/src/ta/ta_redis.py

@@ -1,4 +1,8 @@
-"""interact with redis"""
+"""
+functionality:
+- interact with redis
+- hold temporary download queue in redis
+"""
 
 import json
 import os

tubearchivist/home/views.py

@@ -1,7 +1,7 @@
 """
 Functionality:
 - all views for home app
-- process post data received from frontend via ajax
+- holds base classes to inherit from
 """
 
 import json