InstanceGaming / fsclean

A utility for cleaning up duplicate files and file names.

fsclean

A utility for cleaning up duplicate files and file names.

What this program does:

• Search a directory for duplicate files byte-for-byte (recursively with --recurse).
• Rename files with common name inconsistencies:
  • Extraneous spaces
  • Uppercase extension names
  • Stripping beginning and end of " ", "_", "-"
  • Non alphanumerics or ).(, ].[ directly before or after a "."
• Remove empty files and folders (empties operation).
• Enforce file name style like all uppercase, lowercase, capitalized or title case. See --style.
• Remove or replace spaces in file names. See --space.
• Generate a JSON change log of renamed or removed files. See --changelog.
• Dry run to preview changes (--dry).

Usage

cli.py [-h]
       --op OPERATIONS 
       [--changelog [CHANGELOG_PATH]]
       [--dry]
       [--recurse]
       [--style STYLE]
       [--space SPACE_CHAR]
       [--level LOG_LEVEL]
       targets [targets ...]

Example: Doing a recursive duplicates and naming pass on a directory called exampledir.

$ python cli.py exampledir -r -o duplicates,naming

Argument descriptions

positional arguments:
  targets               one or more paths to target directories.

optional arguments:
  -h, --help            show this help message and exit
  --op OPERATIONS, -o OPERATIONS
                        operations to perform on the target directories, comma-separated. naming, empties, duplicates.
  --changelog [CHANGELOG_PATH], -c [CHANGELOG_PATH]
                        enable and set path for JSON log of changes made by this program. default filename is "changelog.json".
  --dry, -d             don't actually manipulate files, only log what will happen.
  --recurse, -r         Recursively enter subdirectories.
  --style STYLE, -s STYLE
                        specify additional naming rules during the naming operation. capitalized, titlecase, lowercase, uppercase.
  --space SPACE_CHAR, -S SPACE_CHAR
                        replace file name spaces with this character during the naming operation.
  --level LOG_LEVEL, -l LOG_LEVEL
                        logging level (10-50). default is 20 INFO.

Note: Log level integer values can be found in the Python logging package documentation.