#74 some documentation for the management commands and some fixes for…

… the actual commands..

cast/management/commands/s3_media_sizes.py

@@ -7,7 +7,8 @@
 class Command(BaseCommand):
     help = "shows size of media on s3"
 
-    def show_usage(self, paths):
+    @staticmethod
+    def show_usage(paths):
         video_endings = {"mov", "mp4"}
         image_endings = {"jpg", "jpeg", "png"}
         image, video, misc = 0, 0, 0

cast/management/commands/s3_replace.py

@@ -3,7 +3,7 @@
 
 
 class Command(BaseCommand):
-    help = "replace paths on s3 with local versions - useful for" " compressed videos for example"
+    help = "replace paths on s3 with local versions - useful for compressed videos for example"
 
     def add_arguments(self, parser):
         parser.add_argument("paths", nargs="+", type=str)

cast/management/commands/s3_restore.py

@@ -1,11 +1,11 @@
 from django.core.files.storage import default_storage, get_storage_class
 from django.core.management.base import BaseCommand
 
-from blogs.utils import storage_walk_paths
+from cast.utils import storage_walk_paths
 
 
 class Command(BaseCommand):
-    help = "restoremedia files from local media root to s3"
+    help = "restore media files from local media root to s3"
 
     def handle(self, *args, **options):
         s3 = get_storage_class("storages.backends.s3boto3.S3Boto3Storage")()

cast/management/commands/s3_stale.py

@@ -7,9 +7,7 @@
 
 
 class Command(BaseCommand):
-    help = (
-        "show media files which are in the filesystem (s3, locale), " "but not in database and optionally delete them"
-    )
+    help = "show media files which are in the filesystem (s3, locale), but not in database and optionally delete them"
 
     def add_arguments(self, parser):
         parser.add_argument(
@@ -28,11 +26,17 @@ def get_paths(self, storage):
             # print(path, size / 2 ** 20)
         return paths
 
-    def get_models_paths(self):
+    @staticmethod
+    def get_image_paths() -> set[str]:
         paths = set()
         for image in Image.objects.all():
-            for path in image.get_all_paths():
-                paths.add(path)
+            paths.add(image.file.name)
+            for rendition in image.renditions.all():
+                paths.add(rendition.file.name)
+        return paths
+
+    def get_models_paths(self):
+        paths = self.get_image_paths()
         for video in Video.objects.all():
             for path in video.get_all_paths():
                 paths.add(path)

docs/features.rst

@@ -56,3 +56,5 @@ using the Wagtail or Django-Admin interface, the Page and all its subpages
 will be excluded from being indexed by search engines.
 
 .. include:: themes.rst
+
+.. include:: management-commands.rst

docs/management-commands.rst

@@ -0,0 +1,16 @@
+*********************
+Django-Admin Commands
+*********************
+
+There are some management-commands bundled with django-cast. Most of them
+are dealing with the management of media files.
+
+* ``recalc_video_posters``: Recalculate the poster images for all videos.
+* ``s3_backup``: Backup media files from S3 to local media root.
+* ``s3_media_sizes``: Print the sizes of all media files on S3.
+* ``s3_replace``: Replace paths on s3 with versions from local media root.
+  This might be useful for videos for which you now have a better compressed
+  version, but you don't want to generate a new name.
+* ``s3_restore``: Restore media files from local media root to S3.
+* ``s3_stale``: Print the paths of all media files on S3 that are not
+  referenced in the database.

docs/releases/0.2.11.rst

@@ -2,4 +2,5 @@
 -------------------
 
 Htmx for filters
-* ...
+
+* #74 Added some documentation for django-admin commands and fixed ``s3_stale``

docs/releases/index.rst

@@ -8,6 +8,7 @@ Versions
 .. toctree::
    :maxdepth: 1
 
+   0.2.11
    0.2.10
    0.2.9
    0.2.8