create_archive()

audeer.create_archive(root, files, archive, *, verbose=False)

Create ZIP or TAR archive.

If a list with files is provided, only those files will be included to the archive. In that case the files are added in the given order, which may have an influence on the checksum of the archive.

If files is set to None, all files below root will be added in sorted order. This includes hidden files and files from sub-folders, but not empty folders.

Parameters

• root (str) – path to root folder of archive. Only files below root can be included and will be stored relative to root

• files (UnionType[str, Sequence[str], None]) – files that will be included in the archive. Absolute and relative file paths are possible, as long as the files are below root. If set to None all files below root will be added to the archive

• archive (str) – path to archive file. The type of the archive is determined from its file extension

• verbose (bool) – if True a progress bar is shown

Raises

• FileNotFoundError – if root or a file in files is not found

• NotADirectoryError – if root is not a directory

• RuntimeError – if archive does not end with zip, tar, tar.gz, tar.bz2, tar.xz

• RuntimeError – if a file in files is not below root

Examples

>>> file_a = audeer.touch("a.txt")
>>> folder = os.path.dirname(file_a)
>>> file_b = audeer.touch(folder, "b.txt")
>>> archive = audeer.path("archive.zip")
>>> audeer.create_archive(folder, None, archive)
>>> audeer.extract_archive(archive, ".")
['a.txt', 'b.txt']
>>> archive = audeer.path("archive.tar.gz")
>>> audeer.create_archive(folder, ["a.txt"], archive)
>>> audeer.extract_archive(archive, ".")
['a.txt']