Welcome to ‘pathsummary’ documentation!

Path summary is a helper module to summarize the content of a folder based on the mimetypes (file types and sub types).

A trash panda.

Installation

Install the latest release from pip.

$ pip install pathsummary

API reference

pathsummary

pathsummary.summarize_folder_files(folder_path)

Summarizes the content of the folder path.

pathsummary.count_type_occurrences(summary_table)

Counts the occurences of file- and subtypes.

pathsummary.PathSummary

pathsummary.PathSummary.empty

States if the path summary is empty.

pathsummary.PathSummary.summarize_path(...)

Summarizes the content of the given folder path.

pathsummary.PathSummary.from_file_paths(...)

Creates a path summary based on the given file paths.

pathsummary.PathSummary.iter_by_filetype(...)

Iterates the filepaths releated to the file type and optionally sub type.

pathsummary.PathSummary.count_type_occurrences()

Counts the occurences of file- and subtypes.

pathsummary.PathSummary.table

Indices and tables