Skip to main content

A status/progress bar for rsync.

Project description

rsyncy

A status/progress bar for rsync.

I love rsync but I always felt it was either too chatty when transferring lots of small files or did not show enough information for the large files in between.

rsyncy is a fun experiment to fix this without having to bother the rsync developers.

You go from this:

gif of rsync -avh --info=progress2 a/ b

to this:

gif of rsyncy -a a/ b

Status Bar

[########################::::::]  80% |      19.17G |      86.65MB/s | 0:03:18 | #306 | scan 46% (2410)\

The status bar shows the following information:

Description Sample
Progress bar with percentage of the total transfer [########################::::::] 80%
Bytes transferred 19.17G
Transfer speed 86.65MB/s
Elapsed time since starting rsync 0:03:18
Number of files transferred #306
Files to scan/check
- percentage completed
- (number of files)
- spinner
scan 46% (2410)\

The spinner indicates that rsync is still checking if files need to be updated. Until this process completes the progress bar may decrease as new files are found.

Installation

pip3 install --user rsyncy

# or if you have pipx
pipx install rsyncy

Usage

rsyncy is a wrapper around rsync.

  • You run rsyncy with the same arguments as it will pass them to rsync internally.
  • Do not specify any --info arguments, rsyncy will automatically add --info=progress2 and -hv internally.
# simple example
$ rsyncy -a FROM/ TO

Alternatively you can pipe the output from rsync to rsyncy (in which case you need to specify --info=progress2 -hv yourself).

$ rsync -a --info=progress2 -hv FROM/ TO | rsyncy

At the moment rsyncy itself has no options and only supports my preferred way of viewing rsync progress.

Development

First record an rsync transfer with pipevcr, then replay it to rsyncy when debugging.

Project details


Download files

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

Source Distribution

rsyncy-0.0.4.tar.gz (5.1 kB view details)

Uploaded Source

File details

Details for the file rsyncy-0.0.4.tar.gz.

File metadata

  • Download URL: rsyncy-0.0.4.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for rsyncy-0.0.4.tar.gz
Algorithm Hash digest
SHA256 976725bd7bdd86a4832b009059e103917d3c13ff0e49ab964304f3ad1a1457a4
MD5 26ba62c842b4f679e760c0755396ebff
BLAKE2b-256 4bde88c94ad8dcbf9c7f99fe5f5f3c0e1c92f7ece990ffbdb5b33cc5627a9299

See more details on using hashes here.

Provenance

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