# Welcome to CRANE Toolbox’s documentation!

This is the developer documentation for the cranetoolbox package. For information on the package and how to use it, please visit our repo.

Contents:

- importTools module
- preprocess module
- analysis module

`cranetoolbox.fileHandler.``scan_folder`(search_path: str) → [<class ‘str’>]

  List all files in the file-system tree down from the search path.

  Parameters

    search_path (str) – The path that represents the file or folder where the search should be conducted

  Returns

    An array of strings, each representing a single file

  Return type

    list(str)

`cranetoolbox.fileHandler.``scan_folder_csv`(search_path: str) → List[str]

  Scans a given path and extracts all files that end with .csv

  Parameters

    search_path (str) – Any path on the machine

  Returns

    List of CSV files

  Return type

    list(PurePath)

# Indices and tables

- Index

- Module Index

- Search Page