Skip to main content

Tool to backup docker volumes

Project description


PyPI - Version PyPI - Python Version

Table of Contents


"""Usage: porter --version porter backup --to=HOST [--exclude=TARGETS] [--include=INCLUDE] porter restore --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 porter.json file. This file should contain at least one target and at least one host. See ./config/porter.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.


pip install porter

Install from local sources

  1. hatch build
  2. pip install dist/porter-{version}.tar.gz


Publish to PyPi

Ensure you have built a new version of the package:

  1. hatch clean
  2. hatch build

Then publish to the test server:

hatch publish -r test

You will be prompted to enter your username and password. To test the installation, first run Python in a container:

docker run --rm -it --entrypoint bash python


pip install --index-url reside-porter --extra-index-url

Now you should be able to run porter from the command line and see the usage instructions.

If it is working, you can publish to the real PyPi:

hatch publish


porter is distributed under the terms of the MIT license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reside_porter-0.0.1.tar.gz (8.1 kB view hashes)

Uploaded source

Built Distribution

reside_porter-0.0.1-py3-none-any.whl (6.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page