privateer 0.0.1

Tool to backup docker volumes

privateer

---

Table of Contents

• Usage
• Test
• Installation
• License

Usage

  privateer --version
  privateer backup <path> --to=HOST [--exclude=TARGETS] [--include=INCLUDE]
  privateer restore <path> --from=HOST [--exclude=TARGETS] [--include=INCLUDE]

Options:
  --exclude=TARGETS  Comma separated string of target names to exclude (default is to include all)
  --include=TARGETS  Comma separated string of target names to include (default is to include all)

<path> is the path to a directory containing a privateer.json file. This file should contain at least one target and at least one host. See ./config/privateer.json for an example. By default all targets in the config file are used, but this can be overridden by explicitly including or excluding targets by name.

Test and lint

1. hatch run test
2. hatch run lint:fmt

To get coverage reported locally in the console, use hatch run cov. On CI, use hatch run cov-ci to generate an xml report.

Installation

pip install privateer

License

privateer is distributed under the terms of the MIT license.