refacdir

This is a small collection of scripts for file management scripting.

Modify the config_example.yaml file to set a configuration to perform various file management actions.

Available batch actions include:

• Duplicate removal
• File renaming, including the following functions:
  • move_files
  • rename_by_ctime
  • rename_by_mtime
• Directory flattening - take all files in recursive directories and flatten them into the base directory
• Backups, with the following modes:
  • PUSH_AND_REMOVE
  • PUSH
  • PUSH_DUPLICATES
  • MIRROR
  • MIRROR_DUPLICATES
  • FILES_AND_DIRS or DIRS_ONLY (both exclusive of the other modes)
• Observe directory state by counts of file types
• Image categorization using CLIP (requires Weidr)

Define custom named functions and sets of file types in the config YAML filename_mapping_functions and filetype_definitions headers to be referenced in the other parts of the config. Similarly, define custom functions in custom_file_name_search_funcs.py and add the function name refs to the config YAML to add custom search logic for gathering files to rename or move.

For the built-in REP/DIGITS/HEX/ALNUM pattern primitives, you don't need to declare a named filename_mapping_functions entry for every value — an inline {{type:arg1:arg2}} form works directly in a pattern, e.g. {{digits:4}} (four digits), {{hex:64}} (64 uppercase hex chars), or {{alnum:8:true:_}} (8 lowercase alphanumeric chars plus underscore). This is purely additive: existing named filename_mapping_functions declarations keep working unchanged.

Once all configurations are defined, run run.py to perform the actions. The actions will be run in the order they are listed in the config file. Each configuration file will create a batch job which will run in sequence sorted by the name of the config file.

UI

Start the UI by running app.py.

The UI exits automatically after a period without keyboard or mouse activity (default 30 minutes; configurable under Operation Settings).

Server

Set configuration options in config_example.json for a server port to make use of the server while the UI is running. Calls to the server made with Python's multiprocessing client will update the UI as specified, but leave anything unspecified as already set in the UI. This can be helpful to use in conjunction with other applications that involve images. For an example, see this class.