Release v2.2.1

• Added: support for Python 3.13
• Added: support for tar,
  tar.bz2,
  tar.xz
  archives in
  audeer.create_archive(),
  audeer.extract_archive(),
  and audeer.extract_archives()
• Fixed: avoid deprecation warnings
  in Python>=3.12
  by using the "tar" filter
  when extracting tar archives
• Removed: support for Python 3.8

Release v2.2.0

• Added: audeer.script_dir()
  which returns the directory
  of the file where it was called,
  or the current working directory
  when called in an interactive session

Release v2.1.1

• Fixed: make estimation of remaining time
  in audeer.progress_bar()
  less erratic

Release v2.1.0

• Added: audeer.unique(),
  which returns unique values
  in the order they appear in a sequence
• Added: maximum_refresh_time argument
  to audeer.progress_bar()
  and audeer.run_tasks(),
  which can be used
  to force an update interval
  of the progress bar
• Fixed: documentation of return value
  of audeer.run_tasks()

Release v2.0.0

• Added: follow_symlink keyword argument
  to audeer.path()
  with default value False
• Added: follow_symlink keyword argument
  to audeer.rmdir()
  with default value True
• Changed: audeer.path() does no longer
  uses os.path.realpath(),
  but os.path.abspath().
  This means it does no longer convert symlinks
  to the real path,
  but returns the path to the symlink.
  This provides a speed up of audeer.path()
  up to 6x
  as it no longer requires a disk operation.
  The old behavior of audeer.path()
  can be achieved by calling
  audeer.path(..., follow_symlink=True).
  The output of the following functions
  is also affected by this change
  if a symlink is part of their input path:
  audeer.common_directory(),
  audeer.download_url(),
  audeer.list_dir_names(),
  audeer.list_file_names(),
  audeer.mkdir(),
  audeer.touch()
• Changed: the files argument of audeer.create_archive()
  can no longer include symbolic links
  that are located outside of root
• Fixed: audeer.basename_wo_ext(),
  audeer.file_extension(),
  and audeer.replace_file_extension()
  are no longer affected by existing files and symlinks,
  but rely only on the provided input string

Release v1.21.0

• Added: audeer.move()
  which can move files and folders
  and should be used instead of audeer.move_file()
• Added: *paths argument to
  audeer.mkdir(),
  audeer.rmdir(),
  and audeer.touch().
  Instead of writing audeer.mkdir(os.path.join('a', 'b')),
  you can now write audeer.mkdir('a', 'b')

Release v1.20.2

• Added: support for Python 3.12%0A* Fixed: avoid deprecation warning%0A by replacing%0A pkg_resources%0A internally with%0A importlib.metadata%0A* Removed: support for Python 3.7

Release v1.20.1

• Fixed: add missing changelog entry
  for version 1.20.0
  stating that the return values of
  audeer.extract_archive()
  and audeer.extract_archive()
  have changed under Windows
  due to a bug fix

Release v1.20.0

• Added: audeer.md5() to calculate MD5 checksum
  of a file or folder
• Added: short argument to audeer.is_uid().
  If True it checks for a short UID
  like ad855840
• Added: examples to the API documentation of
  audeer.create_archive(),
  audeer.extract_archive(),
  audeer.extract_archives()
• Changed: audeer.list_file_names()
  raises a NotADirectoryError
  if the provided path argument
  is a non-existing folder
  or a folder that is part
  of a search pattern
  that does not exists
• Changed: audeer.create_archive()
  supports now None as files argument,
  which will automatically include all files under root
• Changed: audeer.create_archive()
  now raises a FileNotFoundError
  if root or a file in files cannot be found,
  NotADirectoryError
  if root is not a directory,
  RuntimeError
  if a file in files
  is not located below root
• Changed: audeer.extract_archive()
  and audeer.extract_archives()
  now raise a FileNotFoundError
  if an archive cannot be found,
  IsADirectoryError
  if an archive is a directory,
  NotADirectoryError
  if destination is not a directory
• Fixed: audeer.replace_file_extension()
  now adds the new file extension to the filename
  if no original file extension was present
  instead of replacing the filename
• Fixed: audeer.replace_file_extension()
  now returns the original filename
  when an empty new file extension is provided
  instead of adding '.' at the end of the filename
• Fixed: add raises section
  to API documentation of audeer.list_file_names()
• Fixed: add raises section
  to API documentation of audeer.StrictVersion

Release v1.19.0

• Added: hidden argument to
  audeer.list_dir_names()
  to include hidden folders in results
• Added: remove_from_kwargs argument to
  audeer.deprecated_keyword_argument()
  to indicate if the keyword marked as deprecated
  should be removed from kwargs.
  Default is True
• Added: ext argument to
  audeer.replace_file_extension()
• Added: support for Python 3.10
• Added: support for Python 3.11
• Changed: split API documentation into sub-pages
  for each function/class
• Fixed: add raises section to docstring of
  audeer.list_dir_names()