storyblok-assets-cleanup 0.0.1.dev6

Utility to clean unused storyblok assets.

Cleanup Storyblok assets

storyblok-assets-cleanup is an utility to find and delete unused assets (images, videos, documents, etc) in the Storyblok CMS.

Features:

• Find assets without references;
• Output a summary of file to be deleted, grouped by folder;
• Perform a backup of assets before deletion;

Getting started

Requirements

• Have a Storyblok space and create a personal access token

Installation

pip3 install storyblok-assets-cleanup

Usage

usage: storyblok-assets-cleanup [-h] [--delete | --no-delete] [--backup | --no-backup]
                                [--cache | --no-cache]
                                [--continue-download-on-failure | --no-continue-download-on-failure]
                                [--space-id SPACE_ID] [--token TOKEN]
                                [--blacklisted-folder-paths BLACKLISTED_FOLDER_PATHS]
                                [--blacklisted-words BLACKLISTED_WORDS]
                                [--cache-directory CACHE_DIRECTORY]
                                [--backup-directory BACKUP_DIRECTORY]

storyblok-assets-cleanup an utility to delete unused assets.

options:
  -h, --help            show this help message and exit

  --delete, --no-delete
                        If we should delete assets, default to false.

  --backup, --no-backup
                        If we should backup assets (to ./assets_backup/<SPACE_ID>), defaults to
                        true.

  --cache, --no-cache   If we should use cache the assets index. Defaults to True (recommended).

  --continue-download-on-failure, --no-continue-download-on-failure
                        If we should continue if the download of an asset fails. Defaults to true.

  --space-id SPACE_ID   Storyblok space ID, alternatively use the env var STORYBLOK_SPACE_ID.

  --token TOKEN         Storyblok personal access token, alternatively use the env var
                        STORYBLOK_PERSONAL_ACCESS_TOKEN.

  --blacklisted-folder-paths BLACKLISTED_FOLDER_PATHS
                        Comma separated list of filepaths that should be ignored. Alternatively use
                        the env var BLACKLISTED_ASSET_FOLDER_PATHS. Default to none/empty list.

  --blacklisted-words BLACKLISTED_WORDS
                        Comma separated list of words that should be used to ignore assets when they
                        are contained in its filename. Alternatively use the env var
                        BLACKLISTED_ASSET_FILENAME_WORDS. Default to none/empty list.

  --cache-directory CACHE_DIRECTORY
                        Cache directory, defaults to ./cache.

  --backup-directory BACKUP_DIRECTORY
                        Backup directory, defaults to ./assets_backup.

Development

• Ensure you have make installed.
• Create a virtual environment: make setup-venv.
• Install dependencies: make install-deps.

Then you can install (link) the repo globally with make local-install.

Before pushing changes ensure your code is properly formatted with make lint. Auto format the code with make format.