=======
YARsync
=======
Yet Another Rsync is a file synchronization and backup tool.
It can be used to synchronize data between different hosts
or locally (for example, to a backup drive).
It provides a familiar ``git`` command interface while working with files.
YARsync is a Free Software project covered by the GNU General Public License version 3.
-------------
Installation
-------------
``yarsync`` is packaged for Debian/Ubuntu.
For Arch Linux, install the ``yarsync`` package `from AUR <https://aur.archlinux.org/packages/yarsync>`_.
Packages for other distributions are welcome.
For an installation `from PyPI <https://pypi.org/project/yarsync/>`_, run
.. code-block:: console
pip3 install yarsync
Since there is no general way to install a manual page for a Python package,
one has to do it manually. For example, run as a superuser:
.. code-block:: console
wget https://github.com/ynikitenko/yarsync/raw/master/docs/yarsync.1
gzip yarsync.1
mv yarsync.1.gz /usr/share/man/man1/
mandb
Make sure that the manual path for your system is correct.
The command ``mandb`` updates the index caches of manual pages.
One can also install the most recent program version
`from GitHub <https://github.com/ynikitenko/yarsync>`_.
It incorporates latest improvements,
but at the same time is less stable (new features can be changed or removed).
.. code-block:: console
git clone https://github.com/ynikitenko/yarsync.git
pip3 install -e yarsync
This installs the ``yarsync`` executable to *~/.local/bin*,
and does not require modifications of ``PYTHONPATH``.
After that, one can pull the repository updates without reinstallation.
To **uninstall**, run
.. code-block:: console
pip3 uninstall yarsync
and remove the cloned repository.
--------------------
Design and features
--------------------
``yarsync`` can be used to manage hierarchies of unchanging files,
such as music, books, articles, photographs, etc.
Its final goal is to have the same state of files across
different computers.
It also allows to store backup copies of data and easily copy, update or recover that.
``yarsync`` is
distributed
There is no central host or repository for ``yarsync``.
If different replicas diverge,
the program assists the user to merge the repositories manually.
efficient
The program is run only on user demand,
and does not consume system resources constantly.
Already transferred files will never be transmitted again.
This allows the user to rename or move files
or whole directories without any costs,
driving constant improvements on the repository.
non-intrusive
``yarsync`` does nothing to user data.
It has no complicated packing or unpacking.
All user data and program configuration are stored as usual files in the file system.
If one decides to stop using ``yarsync``,
they can simply remove the configuration directory at any time.
simple
``yarsync`` does not implement complicated file transfer algorithms,
but uses an existing, widely accepted and tested tool for that.
User configuration is stored in simple text files,
and repository snapshots are usual directories, which can be modified, copied
or browsed from a file manager.
All standard command line tools can be used in the repository,
to assist its recovery or to allow any non-standard operations
(for the users who understand what they do).
Read the ``yarsync`` documentation to understand its (simple) design.
safe
``yarsync`` does its best to preserve user data.
It always allows one to see what will be done before any actual modifications
(*--dry-run*). It is its advantage compared to continous synchronization tools,
that may be dangerous if local repository gets corrupt (e.g. encrypted by a trojan).
Removed files are stored in older commits
(until the user explicitly removes those).
..
If a file gets corrupt, it will not be transferred by default,
but when the user chooses to *pull --backup*, any diverged files will be visible
(with their different versions preserved).
---------
Commands
---------
::
checkout
clone
commit
diff
init
log
pull
push
remote
show
status
See ``yarsync --help`` for full command descriptions and options.
----------------------------
Requirements and limitations
----------------------------
``yarsync`` is a Python wrapper (available for ``Python>=3.6``) around ``rsync``
and requires a file system with **hard links**.
Since these are very common tools,
this means that it can easily run on any UNIX-like system.
Moreover, ``yarsync`` is not required to be installed on the remote host:
it is sufficient for ``rsync`` to be installed there.
In particular, ``rsync`` can be found:
* installed on most GNU/Linux distributions,
* installed on `Mac OS <https://eshop.macsales.com/blog/45185-mac-101-learn-the-power-of-rsync-for-backup-remote-archive-systems/>`_,
* can be installed on `Windows <https://superuser.com/questions/300263/how-to-use-rsync-from-windows-pc-to-remote-linux-server>`_.
``yarsync`` runs successfully on Linux.
Please report to us if you have problems (or success) running it on your system.
-------
Safety
-------
``yarsync`` has been used by the author for several years without problems and is tested.
However, any data synchronization may lead to data loss,
and it is recommended to have several data copies
and always do a *--dry-run* (*-n*) first before the actual transfer.
-------------
Documentation
-------------
For the complete documentation, read the installed
or online `manual <https://yarsync.readthedocs.io/en/latest/yarsync.1.html>`_.
For more in-depth topics or alternatives, see
`details <https://yarsync.readthedocs.io/en/latest/details.html>`_.
On the repository github, `release notes <https://github.com/ynikitenko/yarsync/blob/master/NEWS.rst>`_ can be found.
On github pages there is the manual for `yarsync 0.1 <https://ynikitenko.github.io/yarsync/man>`_.
An article in Russian that deals more with ``yarsync`` internals was posted
on `Habr <https://habr.com/ru/post/662163/>`_.
------
Thanks
------
A good number of people have contributed to the improvement of this software.
I'd like to thank
Nilson Silva for packaging ``yarsync`` for Debian,
Mikhail Zelenyy from MIPT NPM for the explanation of
Python `entry points <https://npm.mipt.ru/youtrack/articles/GENERAL-A-87/>`_,
Jason Ryan and Matthew T Hoare for the inspiration to create a package for Arch,
Scimmia for a comprehensive review and suggestions for my PKGBUILD,
Open Data Russia chat for discussions about backup safety,
Habr users and editors, and, finally,
to the creators and developers of ``git`` and ``rsync``.
Raw data
{
"_id": null,
"home_page": "https://github.com/ynikitenko/yarsync",
"name": "yarsync",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "distributed,file,synchronization,rsync,backup",
"author": "Yaroslav Nikitenko",
"author_email": "metst13@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b5/c9/ea87ef19b1029470d4298ab18af03974805375bc99428e00bfbe1af7642f/yarsync-0.2.1.tar.gz",
"platform": null,
"description": "=======\nYARsync\n=======\n\nYet Another Rsync is a file synchronization and backup tool.\nIt can be used to synchronize data between different hosts\nor locally (for example, to a backup drive).\nIt provides a familiar ``git`` command interface while working with files.\n\nYARsync is a Free Software project covered by the GNU General Public License version 3.\n\n-------------\nInstallation\n-------------\n``yarsync`` is packaged for Debian/Ubuntu.\n\nFor Arch Linux, install the ``yarsync`` package `from AUR <https://aur.archlinux.org/packages/yarsync>`_.\nPackages for other distributions are welcome.\n\nFor an installation `from PyPI <https://pypi.org/project/yarsync/>`_, run\n\n.. code-block:: console\n\n pip3 install yarsync\n\nSince there is no general way to install a manual page for a Python package,\none has to do it manually. For example, run as a superuser:\n\n.. code-block:: console\n\n wget https://github.com/ynikitenko/yarsync/raw/master/docs/yarsync.1\n gzip yarsync.1\n mv yarsync.1.gz /usr/share/man/man1/\n mandb\n\nMake sure that the manual path for your system is correct.\nThe command ``mandb`` updates the index caches of manual pages.\n\nOne can also install the most recent program version\n`from GitHub <https://github.com/ynikitenko/yarsync>`_.\nIt incorporates latest improvements,\nbut at the same time is less stable (new features can be changed or removed).\n\n.. code-block:: console\n\n git clone https://github.com/ynikitenko/yarsync.git\n pip3 install -e yarsync\n\nThis installs the ``yarsync`` executable to *~/.local/bin*,\nand does not require modifications of ``PYTHONPATH``.\nAfter that, one can pull the repository updates without reinstallation.\n\nTo **uninstall**, run\n\n.. code-block:: console\n\n pip3 uninstall yarsync\n\nand remove the cloned repository.\n\n--------------------\nDesign and features\n--------------------\n\n``yarsync`` can be used to manage hierarchies of unchanging files,\nsuch as music, books, articles, photographs, etc.\nIts final goal is to have the same state of files across\ndifferent computers.\nIt also allows to store backup copies of data and easily copy, update or recover that.\n``yarsync`` is\n\ndistributed\n There is no central host or repository for ``yarsync``.\n If different replicas diverge,\n the program assists the user to merge the repositories manually.\n\nefficient\n The program is run only on user demand,\n and does not consume system resources constantly.\n Already transferred files will never be transmitted again.\n This allows the user to rename or move files\n or whole directories without any costs,\n driving constant improvements on the repository.\n\nnon-intrusive\n ``yarsync`` does nothing to user data.\n It has no complicated packing or unpacking.\n All user data and program configuration are stored as usual files in the file system.\n If one decides to stop using ``yarsync``,\n they can simply remove the configuration directory at any time.\n\nsimple\n ``yarsync`` does not implement complicated file transfer algorithms,\n but uses an existing, widely accepted and tested tool for that.\n User configuration is stored in simple text files,\n and repository snapshots are usual directories, which can be modified, copied\n or browsed from a file manager.\n All standard command line tools can be used in the repository,\n to assist its recovery or to allow any non-standard operations\n (for the users who understand what they do).\n Read the ``yarsync`` documentation to understand its (simple) design.\n\nsafe\n ``yarsync`` does its best to preserve user data.\n It always allows one to see what will be done before any actual modifications\n (*--dry-run*). It is its advantage compared to continous synchronization tools,\n that may be dangerous if local repository gets corrupt (e.g. encrypted by a trojan).\n Removed files are stored in older commits\n (until the user explicitly removes those).\n\n..\n If a file gets corrupt, it will not be transferred by default,\n but when the user chooses to *pull --backup*, any diverged files will be visible\n (with their different versions preserved).\n\n---------\nCommands\n---------\n\n::\n\n checkout\n clone\n commit\n diff\n init\n log\n pull\n push\n remote\n show\n status\n\nSee ``yarsync --help`` for full command descriptions and options.\n\n----------------------------\nRequirements and limitations\n----------------------------\n``yarsync`` is a Python wrapper (available for ``Python>=3.6``) around ``rsync``\nand requires a file system with **hard links**.\nSince these are very common tools,\nthis means that it can easily run on any UNIX-like system.\nMoreover, ``yarsync`` is not required to be installed on the remote host:\nit is sufficient for ``rsync`` to be installed there.\n\nIn particular, ``rsync`` can be found:\n\n* installed on most GNU/Linux distributions,\n* installed on `Mac OS <https://eshop.macsales.com/blog/45185-mac-101-learn-the-power-of-rsync-for-backup-remote-archive-systems/>`_,\n* can be installed on `Windows <https://superuser.com/questions/300263/how-to-use-rsync-from-windows-pc-to-remote-linux-server>`_.\n\n``yarsync`` runs successfully on Linux.\nPlease report to us if you have problems (or success) running it on your system.\n\n-------\nSafety\n-------\n``yarsync`` has been used by the author for several years without problems and is tested.\nHowever, any data synchronization may lead to data loss,\nand it is recommended to have several data copies\nand always do a *--dry-run* (*-n*) first before the actual transfer.\n\n-------------\nDocumentation\n-------------\n\nFor the complete documentation, read the installed\nor online `manual <https://yarsync.readthedocs.io/en/latest/yarsync.1.html>`_.\n\nFor more in-depth topics or alternatives, see\n`details <https://yarsync.readthedocs.io/en/latest/details.html>`_.\n\nOn the repository github, `release notes <https://github.com/ynikitenko/yarsync/blob/master/NEWS.rst>`_ can be found.\nOn github pages there is the manual for `yarsync 0.1 <https://ynikitenko.github.io/yarsync/man>`_.\n\nAn article in Russian that deals more with ``yarsync`` internals was posted\non `Habr <https://habr.com/ru/post/662163/>`_.\n\n------\nThanks\n------\n\nA good number of people have contributed to the improvement of this software.\nI'd like to thank\nNilson Silva for packaging ``yarsync`` for Debian,\nMikhail Zelenyy from MIPT NPM for the explanation of\nPython `entry points <https://npm.mipt.ru/youtrack/articles/GENERAL-A-87/>`_,\nJason Ryan and Matthew T Hoare for the inspiration to create a package for Arch,\nScimmia for a comprehensive review and suggestions for my PKGBUILD,\nOpen Data Russia chat for discussions about backup safety,\nHabr users and editors, and, finally,\nto the creators and developers of ``git`` and ``rsync``.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Yet Another Rsync is a file synchronization and backup tool",
"version": "0.2.1",
"split_keywords": [
"distributed",
"file",
"synchronization",
"rsync",
"backup"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a8be207e364cec4a106d6150bfe87e78252ba3894277c26ce94d05921be53575",
"md5": "fe789c63344e54c0aa0ed45aeb6fe53c",
"sha256": "b64437b48c96637a43d7767e1c1375f1f1bf72f8cd8b73449cb4496bdafdac03"
},
"downloads": -1,
"filename": "yarsync-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe789c63344e54c0aa0ed45aeb6fe53c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 45690,
"upload_time": "2023-03-28T16:18:51",
"upload_time_iso_8601": "2023-03-28T16:18:51.138267Z",
"url": "https://files.pythonhosted.org/packages/a8/be/207e364cec4a106d6150bfe87e78252ba3894277c26ce94d05921be53575/yarsync-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5c9ea87ef19b1029470d4298ab18af03974805375bc99428e00bfbe1af7642f",
"md5": "037f02366c651b33c6647589961f8f63",
"sha256": "40b5ced308d342fec8896d19c5bdd7c20bde7e578ec44ee24eefd9fdca838cc5"
},
"downloads": -1,
"filename": "yarsync-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "037f02366c651b33c6647589961f8f63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 58696,
"upload_time": "2023-03-28T16:18:53",
"upload_time_iso_8601": "2023-03-28T16:18:53.640432Z",
"url": "https://files.pythonhosted.org/packages/b5/c9/ea87ef19b1029470d4298ab18af03974805375bc99428e00bfbe1af7642f/yarsync-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-28 16:18:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ynikitenko",
"github_project": "yarsync",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "yarsync"
}
JSON
