piper.io.zip_data

piper.io.zip_data(source: str = 'outputs', filter: str = '*.xls*', target: str = 'outputs/zip_data', ts_prefix: str = 'date', include_folder: bool = True, recurse: bool = False, info: bool = False, mode: str = 'w', test_mode: bool = False) → Union[zipfile.ZipFile, Any][source]

Compress files from source to target folder

Parameters

  • source – source folder containing the files to zip.

  • filter – default scans for xlsx files.

  • target – target zip file name to create.

  • ts_prefix – timestamp file name prefix. ‘date’ (date only) -> default False (no timestamp) True (timestamp prefix)

  • include_folder – True (default). Zipped files include the original folder reference that the file resided in.

  • recurse – default (False) Recurse folders

  • mode – default ‘w’ (write), ‘a’ (add)

  • test_mode – default (False), if True - do not create zip

Returns

Return type

None

Examples

zip_data(source='outputs/', filter=f'{date_prefix}*.xsv',
         target='outputs/test', ts_prefix=True,
         include_folder=True, recurse=True, info=False,
         test_mode=False)

Source: outputs, filter: 20200614*.xsv WARNING: No files found for selected folder/filter.

piper.io.write_text custom module