Metadata-Version: 2.1
Name: blocksync
Version: 0.1.3
Summary: Synchronize (large) files to a destination (local/remote) using a incremental algorithm
Home-page: https://github.com/ehdgua01/blocksync
Author: ehdgua01
Author-email: ehdgua01@gmail.com
License: UNKNOWN
Keywords: file synchronize,incremental algorithm
Platform: Any
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Requires-Dist: paramiko

blocksync
=========

Blocksync Python package allows `blocksync script`_ to be used as Python packages, and supports more convenient and diverse functions than blocksync script.

.. _blocksync script: http://https://github.com/theraser/blocksync

Features
--------
* Synchronize the destination (remote or local) files using an incremental algorithm.
* Supports SCP-like behavior. (local-local, local-remote, remote-local, remote-remote)
* Support for callbacks that can run just before, after, and during synchronization of files
* Support for synchronization suspend/resume, cancel.
* You can see the overall progress in a multi-threaded environment.
* You can proceed synchronization in the background.
* You can multi hash when storing data. (by `hashlib`_)
* You can specify the number of workers (number of threads) to perform synchronization.

.. _hashlib: https://docs.python.org/3/library/hashlib.html

Prerequisites
-------------
* Python 3.8 or later
* `paramiko`_

.. _paramiko: http://www.paramiko.org/

Installation
------------
.. code-block:: bash

    pip install blocksync

Examples
--------
Please refer to `examples`_ at the beginning.

.. _examples: https://github.com/ehdgua01/blocksync/tree/master/examples

License
-------
MIT License (For more information about this license, please see `this`_)

.. _this: https://en.wikipedia.org/wiki/MIT_License


