Getting Started

Installation

Install FileJanitor using pip:

pip install -i https://test.pypi.org/simple/ filejanitor

Basic Usage

Import the functions you need:

from FileJanitor import (
    flatten,
    index_files,
    replace_pattern,
    standardize_filename
)

Your First Cleanup

# Standardize a filename
clean_name = standardize_filename("messy file name.txt", case="lower")
print(clean_name)  # Output: messy_file_name.txt

See the Examples page for more detailed usage patterns.