Archive-tools

~~~~~~~~~~~~~~~~

New features
------------

+ `52`_, `70`_: Add a `backup-tool` script.

+ `54`_: Add command line flags `--directory <dir>` to
`archive-tool create`. The script will change into this directory
prior creating the archive if provided.

+ `54`_: Add new keyword argument `fileinfos` that :class:`Manifest`
and :meth:`Archive.create` accept.

+ `57`_, `66`_: Add :func:`diff_manifest`. The `archive-tool diff`
command with `--report-meta` flag also reports differences in file
system metadata for directories and symbol links.

+ `50`_, `51`_: Add a header with some metadata to the index in a
mail archive created by :class:`MailArchive`.

+ `62`_, `63`_: Explicitely select POSIX.1-2001 (pax) format in the
tarfile. This fixes failing verification if the archive contains a
directory with a long path name.

+ `67`_: Add :mod:`archive.index` providing :class:`ArchiveIndex`.

Incompatible changes
--------------------

+ `60`_: Drop support for Python 3.4 and 3.5.

+ The `comment` keyword argument to :class:`MailArchive` has been
dropped, ref. `51`_.

Bug fixes and minor changes
---------------------------

+ `59`_: Change :attr:`Archive.path` to the absolute path of the
archive.

+ `57`_: Do not take the paths relative to the base directory in the
`archive-tool diff` command.

+ `58`_: Weaken the condition introduced in `9`_ that basedir must
be a directory.

+ `61`_: Review date helper functions in :mod:`archive.tools`

- Add :func:`date_str_rfc5322`.

- :func:`parse_date` now also accepts date strings as returned by
:meth:`datetime.datetime.isoformat`.

+ Make `compression` keyword argument to :meth:`Archive.create`
optional. The default will be derived from the suffixes of the
`path` argument.

+ `65`_: Add a method :meth:`Archive.extract_member` to extract an
individual member of the archive.

+ `53`_, `54`_: Spurious :exc:`FileNotFoundError` from
:meth:`Archive.create` when passing a relative path as `workdir`
argument.

+ `55`_, `57`_: `archive-tool diff` fails with :exc:`TypeError`.

+ `56`_, `57`_: Inconsistent result from `archive-tool diff` with
option `--skip-dir-content`.

+ `64`_, `65`_: :meth:`Archive.extract` does not preserve the file
modification time for symbol links.

+ `48`_: Review and standardize some error messages.

Internal changes
----------------

+ `68`_: Add :mod:`archive.config`.

.. _48: https://github.com/RKrahl/archive-tools/pull/48
.. _50: https://github.com/RKrahl/archive-tools/issues/50
.. _51: https://github.com/RKrahl/archive-tools/pull/51
.. _52: https://github.com/RKrahl/archive-tools/issues/52
.. _53: https://github.com/RKrahl/archive-tools/issues/53
.. _54: https://github.com/RKrahl/archive-tools/pull/54
.. _55: https://github.com/RKrahl/archive-tools/issues/55
.. _56: https://github.com/RKrahl/archive-tools/issues/56
.. _57: https://github.com/RKrahl/archive-tools/pull/57
.. _58: https://github.com/RKrahl/archive-tools/pull/58
.. _59: https://github.com/RKrahl/archive-tools/pull/59
.. _60: https://github.com/RKrahl/archive-tools/pull/60
.. _61: https://github.com/RKrahl/archive-tools/pull/61
.. _62: https://github.com/RKrahl/archive-tools/issues/62
.. _63: https://github.com/RKrahl/archive-tools/pull/63
.. _64: https://github.com/RKrahl/archive-tools/issues/64
.. _65: https://github.com/RKrahl/archive-tools/pull/65
.. _66: https://github.com/RKrahl/archive-tools/pull/66
.. _67: https://github.com/RKrahl/archive-tools/pull/67
.. _68: https://github.com/RKrahl/archive-tools/pull/68
.. _70: https://github.com/RKrahl/archive-tools/pull/70

~~~~~~~~~~~~~~~~~~

Bug fixes and minor changes
---------------------------

+ `46`_, `47`_: `archive-tool` fails with :exc:`NameError` when
trying to emit a warning.

.. _46: https://github.com/RKrahl/archive-tools/issues/46
.. _47: https://github.com/RKrahl/archive-tools/pull/47

~~~~~~~~~~~~~~~~

New features
------------

+ `45`_: The files argument to `archive-tool check` defaults to the
archive's basedir.

Bug fixes and minor changes
---------------------------

+ Fix: some test data have not been included in the source
distribution.

.. _45: https://github.com/RKrahl/archive-tools/issues/45

~~~~~~~~~~~~~~~~

New features
------------

+ `15`_, `43`_: Add `archive-tool find` subcommand.

+ `38`_, `39`_: Add `archive-tool diff` subcommand.

+ `40`_, `44`_: Add setting tags in the header of the manifest.

+ `41`_: Add a :meth:`Archive.extract` method.

+ Add a :meth:`Manifest.sort` method.

Internal changes
----------------

+ Reorganization of the `archive-tool` script, move the code into
submodules in the new `archive.cli` package.

.. _15: https://github.com/RKrahl/archive-tools/issues/15
.. _38: https://github.com/RKrahl/archive-tools/issues/38
.. _39: https://github.com/RKrahl/archive-tools/pull/39
.. _40: https://github.com/RKrahl/archive-tools/issues/40
.. _41: https://github.com/RKrahl/archive-tools/pull/41
.. _43: https://github.com/RKrahl/archive-tools/pull/43
.. _44: https://github.com/RKrahl/archive-tools/pull/44

~~~~~~~~~~~~~~~~

New features
------------

+ `33`_: `archive-tool create` should have an option to exclude files.

+ `35`_: :class:`FileInfo` calculates checksums lazily.

+ `34`_: files of unsupported type are ignored when creating an
archive. A warning is emitted instead of raising an error.

Incompatible changes
--------------------

+ `36`_: Drop support for strings in the file name arguments `path`,
`paths`, `basedir`, and `workdir` of the methods
:meth:`Archive.create` and :meth:`Archive.open`. These arguments
require :class:`Path` objects now.

Bug fixes and minor changes
---------------------------

+ `37`_: `archive-tool create` throws an error when trying to
explicitly add a symlink.

.. _33: https://github.com/RKrahl/archive-tools/issues/33
.. _34: https://github.com/RKrahl/archive-tools/issues/34
.. _35: https://github.com/RKrahl/archive-tools/issues/35
.. _36: https://github.com/RKrahl/archive-tools/pull/36
.. _37: https://github.com/RKrahl/archive-tools/issues/37

~~~~~~~~~~~~~~~~

New features
------------

+ `28`_: support deduplication.

+ `26`_ and `30`_: add support for custom metadata:

- Add methods :meth:`Archive.add_metadata` and
:meth:`Archive.get_metadata` to add and to retrieve custom
metadata to and from archives.

- Add a list of metadata items in the header of the manifest.

- Bump manifest version to 1.1.

+ `4`_, `32`_: Add :class:`MailArchive` implementing a special
flavour of an :class:`Archive` for storing mails.

+ `27`_: Add command line flags `--prefix <dir>` and `--stdin` to
`archive-tool check`.

Incompatible changes
--------------------

+ `23`_ and `26`_: review the API of :class:`Archive`:

- Add two methods :meth:`Archive.create` and :meth:`Archive.open`
that create and read archives respectively.

- The :meth:`Archive.__init__` method does not create or open
archives any longer.

- :meth:`Archive.verify` does not accept the mode argument any more.

- :class:`Archive` keeps a file object to read the tarfile. It is
opened in :meth:`Archive.open`. :meth:`Archive.verify` does not
reopen the tarfile, but relies on the internal file object to be
left open.

- Add a :meth:`Archive.close` method.

- :class:`Archive` implements the context manager protocol.

Bug fixes and minor changes
---------------------------

+ `20`_: :meth:`Archive.create` takes a working directory as optional
argument.

+ `29`_: Verify fails if archive contains hard links.

+ `25`_: `archive-tool check` should ignore metadata.

.. _4: https://github.com/RKrahl/archive-tools/issues/4
.. _20: https://github.com/RKrahl/archive-tools/issues/20
.. _23: https://github.com/RKrahl/archive-tools/issues/23
.. _25: https://github.com/RKrahl/archive-tools/issues/25
.. _26: https://github.com/RKrahl/archive-tools/pull/26
.. _27: https://github.com/RKrahl/archive-tools/issues/27
.. _28: https://github.com/RKrahl/archive-tools/issues/28
.. _29: https://github.com/RKrahl/archive-tools/issues/29
.. _30: https://github.com/RKrahl/archive-tools/pull/30
.. _32: https://github.com/RKrahl/archive-tools/pull/32