FileBackup

Tool for creating and restoring file system backups.


License
MIT
Install
pip install FileBackup==0.2.0

Documentation

FileBackup

CI Code Coverage License GitHub commit activity PyPI - Python Version PyPI - Version PyPI - Downloads OpenSSF Best Practices

Tool for creating and restoring file system backups.

Contents

Overview

TODO: Complete this section

How to use FileBackup

TODO: Complete this section

Installation

FileBackup can be installed via one of these methods:

Installation via Executable

Download an executable for Linux, MacOS, or Windows to use the functionality provided by this repository without a dependency on Python.

  1. Download the archive for the latest release here; the files will begin with exe. and contain the name of your operating system.
  2. Decompress the archive

Verifying Signed Executables

Executables are signed and validated using Minisign.

The public key for executables in this repository is RWTO8gifpEKQhwiguxsldM47Php1GeTs0foueIpaLPp0xSy0N5FBn/70.

To verify that the executable is valid, download the corresponding .minisig file here and run this command, replacing <filename> with the name of your file.

docker run -i --rm -v .:/host jedisct1/minisign -V -P RWTO8gifpEKQhwiguxsldM47Php1GeTs0foueIpaLPp0xSy0N5FBn/70 -m /host/<filename>

Instructions for installing docker are available at https://docs.docker.com/engine/install/.

Installation via pip

Install the FileBackup package via pip (Package Installer for Python) to use it with your python code.

pip install FileBackup

Contributing

See CONTRIBUTING.md for information on contributing to FileBackup.

Local Development

See DEVELOPMENT.md for information on developing or testing FileBackup on your local Linux, MacOS, or Windows machine.

Vulnerability Reporting (Security Issues)

Please privately report vulnerabilities you find so we can fix them!

See SECURITY.md for information on how to privately report vulnerabilities.

License

FileBackup is licensed under the MIT license.