Skip to main content

Installation | Basic Usage | Documentation | Contributing

WereSync Logo

A lone hard drive stands atop a data heap, staring at the full moon. Suddenly, it transforms…into a bootable clone of your drive, whirring hungrily at the digital moon.

WereSync takes a Linux hard drive and effectively clones it, but works incrementally so you don’t have to spend so long backing up each time. Additionally, WereSync can clone to a smaller drive, if your data will fit on the smaller drive. Because WereSync uses rsync to copy, it can copy a running drive, though certain parts of state may not be preserved.

Why Use WereSync?

Hopefully, you think this project looks amazing and you want to try it right away. However, you may be skeptical about the usefulness of WereSync. You may be thinking, I can do this exact same thing using gparted or ddrescue. Hear me out! There are a few reasons to use WereSync over the other tools.

  • WereSync is accessible to less-technical users. It comes with a simple interface and clone a drive with a single command while your computer is running. No booting to a live disk or pushing through a long initiation process. Unlike dd or CloneZilla, WereSync requires a low level of technical skill and has an easy learning curve

  • WereSync can run while the your main drive is being used, instead of blocking your computer up for hours at a time

  • WereSync will incrementally update clones, making subsequent clones much faster.

  • WereSync works quickly, a single command copies your entire drive, no booting to live CDs or managing MBRs.

  • WereSync can copy to a smaller drive, provided your drive’s data will fit.

  • WereSync creates new UUIDs for the new partitions, allowing you to use the old and new drives alongside each other.

Full documentation may be found here.

Installation

WereSync can be installed using the setup.py file.

$ ./setup.py install

If you have pip installed, you can easily install WereSync with the following command:

$ pip install weresync

For more in-depth instructions, see the installation documentation.

Basic Usage

Note: WereSync requires root capabilities to run because it has to access block devices.

The gui can be launched with the command:

$ sudo weresync-gui

Which generates the following GUI, though generally the advanced options are unneeded:

Picture of WereSync GUI

To see the options for the terminal command use:

$ weresync -h

To copy from /dev/sda to /dev/sdb (the two drives must have the same partition scheme) use:

$ sudo weresync /dev/sda /dev/sdb

For more information, including how to copy the partition table from drive to another, see the Basic Usage documentation page.

Documentation

Documentation can be found on the Read the Docs.

Contributing and Bug Reports

First, take a look at our contribution guidelines.

To contribute simply fork this repository, make your changes, and submit a pull request. Bugs can be reported on the issue tracker

WereSync currently has huge need of people testing the program on complex drive setups. In order to do this please:

  1. Install WereSync from pip:

    pip install weresync
  2. Run it on your system:

    sudo weresync -C source_drive target_drive
  3. Report any errors to the issue tracker. Please be sure to post the contents of /var/log/weresync/weresync.log and fdisk -l.

All contributions will be greatly appreciated!

Distributions Capability for Drive Copying

ubuntu debian arch centos fedora opensuse

If you are able to test any of these systems, please report your exprience at the issue tracker. Any help will be much appreciated.

Licensing

This project is licensed under the Apache 2.0 License. Licensing is in the LICENSE.txt file in this directory.

Acknowledgments

Huge thanks to the creators of:

Metadata

Release files for WereSync 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for WereSync 1.0.3
File Size Uploaded Provenance
WereSync-1.0.3.tar.gz 66.4 kB Without provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for WereSync 1.0.3
File Interpreter ABI Platform
WereSync-1.0.3-py3.4.egg Legacy Egg format - - Details
WereSync-1.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 325.7 kB

Release files / WereSync-1.0.3.tar.gz

Download URL WereSync-1.0.3.tar.gz
Size 66.4 kB
Tags Source
SHA-256 checksum
How to use checksums
33921add1c7fde388d49b871d0ea3b12382977c10a66710624db0d2df121b277
BLAKE2b-256 checksum
How to use checksums
7f6958781505bcdc4f34273d48740f442c684426e0ac12c4e681804ebb02af5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / WereSync-1.0.3-py3.4.egg

Download URL WereSync-1.0.3-py3.4.egg
Size 150.3 kB
Tags Egg
SHA-256 checksum
How to use checksums
27fd8a3ac17f0a3a37eaa32893d434bfcaad2936b3b8ccc10619a29cb1d6a948
BLAKE2b-256 checksum
How to use checksums
5c0fc78778171cfe755ddd6fdc15158a86cf20c6122c7ecbd47959c65cee3351
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / WereSync-1.0.3-py3-none-any.whl

Download URL WereSync-1.0.3-py3-none-any.whl
Size 109.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9d08306cb3ffde8548a149031693a08c83bba8b4f2db6519782345e645d7d5d1
BLAKE2b-256 checksum
How to use checksums
4ef36fb13a0b836ae9bbec11b565cf58de70fbb6ddba1d155f3562a7a9810365
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for WereSync 1.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page