Metadata-Version: 2.1
Name: rsyncy
Version: 0.0.3
Summary: A status bar for rsync.
Home-page: https://github.com/laktak/rsyncy
Author: Christian Zangl
Author-email: laktak@cdak.net
License: UNKNOWN
Description: 
        # rsyncy
        
        A status bar for [rsync](https://github.com/WayneD/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.
        
        ![rsyncy](https://raw.githubusercontent.com/laktak/rsyncy/master/readme/demo.gif)
        
        ## Status Bar
        
        ```
        [########################::::::]  80% |      19.17G |      86.65MB/s | 0:03:18 | #306 | chk 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 check<br>- percentage completed<br>- (number of files)<br>- spinner | `chk 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).
        
        ```
        $ rsyncy -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](https://github.com/laktak/pipevcr), then replay it to rsyncy when debugging.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
