update doc strings to represent new module structure

This commit is contained in:
simon 2022-01-23 19:32:08 +07:00
parent 0fc0cc8e87
commit 2fc0cbacf5
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
16 changed files with 65 additions and 16 deletions

View File

@ -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,

View File

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

View File

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

View File

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

View File

@ -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

View File

@ -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

View File

@ -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

View File

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

View File

@ -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

View File

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

View File

@ -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

View File

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

View File

@ -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

View File

@ -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

View File

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

View File

@ -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