# WatchSync
[](https://coveralls.io/github/rlizana/watchsync?branch=main)
[](https://badge.fury.io/py/watchsync)
[](https://opensource.org/licenses/AGPL-3.0)
WatchSync is a tool for synchronizing files when they are created or modified across different storage locations. A file can also be a local directory that, when detected as modified or created, is synchronized with the configured storage locations. A storage location can be a local or remote directory where a copy of the files will be sent.
The purpose of this tool is to have a backup of files in different storage locations to avoid losing important information. It is a file replication solution that is very easy to configure and use.
## Features
- Automatic synchronization of files and directories.
- Support for multiple local and remote storage locations.
- Easy to configure and use.
- Uses `rsync` for efficient file synchronization.
## Installation
### Requirements
WatchSync uses `rsync` for file synchronization, so it must be installed on the system. On Debian-based systems, it can be installed with the following command:
```bash
sudo apt install rsync
```
### As a package
Install the package with pip:
```bash
pip install watchsync
```
### From source code
Clone the repository:
```bash
git clone https://github.com/rlizana/watchsync.git
cd watchsync
```
Install dependencies and build the package:
```bash
poetry install
```
Install the package globally:
```bash
poetry build
pip install dist/watchsync-*.whl
```
## Usage
WatchSync uses a daemon to monitor file changes and synchronize them with storage locations. A storage location can be a local directory, a remote server, or a git repository.
To start the daemon, use `watchsync start`, and to stop it, use `watchsync stop`. If you want to restart the daemon to reread configuration changes, use `watchsync reload`.
### Storage Locations
To manage storage locations, use the command `watchsync store`.
You can list storage locations with `watchsync store list`, add a storage location with `watchsync store add NAME TYPE PATH`, and remove one with `watchsync store del NAME`.
Alternatively, you can edit the configuration file `~/.config/watchsync/config.yaml` to add storage locations manually, but note that the daemon will not pick up changes until you restart it after making modifications.
### Files
To manage the files being monitored, use the command `watchsync file`.
You can list files with `watchsync file list`, add a file with `watchsync file add PATH`, and remove a file with `watchsync file del PATH`.
## Development
This project is developed using TDD. Therefore, any changes or improvements to be added must first include a failing unit test, and then the necessary code must be written to make the test pass.
Install the development dependencies:
```bash
poetry install --with dev
poetry run pre-commit install
```
To run unit tests:
```bash
poetry run python3 -m unittest discover -s tests
```
With coverage:
```bash
poetry run coverage run -m unittest discover -s tests
poetry run coverage report
```
Or you can run with one of these commands
```bash
poetry run watchsync
poetry run python3 -m watchsync
poetry run python3 -m watchsync.daemon.watchsyncd
```
## Test using Docker
You can use docker to test the tool. The following command will build the image and run the tests:
```bash
docker build -t watchsync-test .
docker run --rm watchsync-test
```
If you are developing, you can use the following command to mount the current directory in the container and run the tests:
```bash
docker run --rm -v $(pwd)/watchsync:/watchsync/watchsync -v $(pwd)/tests:/watchsync/tests watchsync-test
```
Raw data
{
"_id": null,
"home_page": "https://github.com/rlizana/watchsync",
"name": "watchsync",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "rsync, watchdog, real-time, synchronization, watchfiles, sync, inotify, file monitoring, file synchronization, file replication, file sync, file watcher",
"author": "Roberto Lizana",
"author_email": "rober.lizana@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/11/9a/f73e1fef99d86df9c8d506ea94cefbf95f20be897ba413e9d26c01ad4ae5/watchsync-0.1.2.tar.gz",
"platform": null,
"description": "# WatchSync\n\n\n[](https://coveralls.io/github/rlizana/watchsync?branch=main)\n[](https://badge.fury.io/py/watchsync)\n[](https://opensource.org/licenses/AGPL-3.0)\n\nWatchSync is a tool for synchronizing files when they are created or modified across different storage locations. A file can also be a local directory that, when detected as modified or created, is synchronized with the configured storage locations. A storage location can be a local or remote directory where a copy of the files will be sent.\n\nThe purpose of this tool is to have a backup of files in different storage locations to avoid losing important information. It is a file replication solution that is very easy to configure and use.\n\n## Features\n\n- Automatic synchronization of files and directories.\n- Support for multiple local and remote storage locations.\n- Easy to configure and use.\n- Uses `rsync` for efficient file synchronization.\n\n## Installation\n\n### Requirements\n\nWatchSync uses `rsync` for file synchronization, so it must be installed on the system. On Debian-based systems, it can be installed with the following command:\n\n```bash\nsudo apt install rsync\n```\n\n### As a package\n\nInstall the package with pip:\n\n```bash\npip install watchsync\n```\n\n### From source code\n\nClone the repository:\n\n```bash\ngit clone https://github.com/rlizana/watchsync.git\ncd watchsync\n```\n\nInstall dependencies and build the package:\n\n```bash\npoetry install\n```\n\nInstall the package globally:\n\n```bash\npoetry build\npip install dist/watchsync-*.whl\n```\n\n## Usage\n\nWatchSync uses a daemon to monitor file changes and synchronize them with storage locations. A storage location can be a local directory, a remote server, or a git repository.\n\nTo start the daemon, use `watchsync start`, and to stop it, use `watchsync stop`. If you want to restart the daemon to reread configuration changes, use `watchsync reload`.\n\n### Storage Locations\n\nTo manage storage locations, use the command `watchsync store`.\n\nYou can list storage locations with `watchsync store list`, add a storage location with `watchsync store add NAME TYPE PATH`, and remove one with `watchsync store del NAME`.\n\nAlternatively, you can edit the configuration file `~/.config/watchsync/config.yaml` to add storage locations manually, but note that the daemon will not pick up changes until you restart it after making modifications.\n\n### Files\n\nTo manage the files being monitored, use the command `watchsync file`.\n\nYou can list files with `watchsync file list`, add a file with `watchsync file add PATH`, and remove a file with `watchsync file del PATH`.\n\n## Development\n\nThis project is developed using TDD. Therefore, any changes or improvements to be added must first include a failing unit test, and then the necessary code must be written to make the test pass.\n\nInstall the development dependencies:\n\n```bash\npoetry install --with dev\npoetry run pre-commit install\n```\n\nTo run unit tests:\n\n```bash\npoetry run python3 -m unittest discover -s tests\n```\n\nWith coverage:\n\n```bash\npoetry run coverage run -m unittest discover -s tests\npoetry run coverage report\n```\n\nOr you can run with one of these commands\n\n```bash\npoetry run watchsync\npoetry run python3 -m watchsync\npoetry run python3 -m watchsync.daemon.watchsyncd\n```\n\n## Test using Docker\n\nYou can use docker to test the tool. The following command will build the image and run the tests:\n\n```bash\ndocker build -t watchsync-test .\ndocker run --rm watchsync-test\n```\n\nIf you are developing, you can use the following command to mount the current directory in the container and run the tests:\n\n```bash\ndocker run --rm -v $(pwd)/watchsync:/watchsync/watchsync -v $(pwd)/tests:/watchsync/tests watchsync-test\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A Python-based tool for real-time file monitoring and synchronization, designed to replicate changes between local or remote locations.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/rlizana/watchsync",
"Repository": "https://github.com/rlizana/watchsync"
},
"split_keywords": [
"rsync",
" watchdog",
" real-time",
" synchronization",
" watchfiles",
" sync",
" inotify",
" file monitoring",
" file synchronization",
" file replication",
" file sync",
" file watcher"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4499a6a21433d96fcf36faf86bdad92fa5001d329c56e880062dcbfa7a04a694",
"md5": "5d65259ef3f5f18f64639d1c6ac53a27",
"sha256": "5f3fdd2f7a4ee9870e729b1ac358e27ec3e1b32db8f7b23736fd2b8e6cad67a8"
},
"downloads": -1,
"filename": "watchsync-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d65259ef3f5f18f64639d1c6ac53a27",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 30558,
"upload_time": "2025-01-10T23:47:20",
"upload_time_iso_8601": "2025-01-10T23:47:20.814361Z",
"url": "https://files.pythonhosted.org/packages/44/99/a6a21433d96fcf36faf86bdad92fa5001d329c56e880062dcbfa7a04a694/watchsync-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "119af73e1fef99d86df9c8d506ea94cefbf95f20be897ba413e9d26c01ad4ae5",
"md5": "bf9326a3a4c140cad3e37dae48f36316",
"sha256": "886022d2a39480a666a75e54109c637566ca551ac64e53be1b6b18663a3b2f9c"
},
"downloads": -1,
"filename": "watchsync-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "bf9326a3a4c140cad3e37dae48f36316",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 24704,
"upload_time": "2025-01-10T23:47:23",
"upload_time_iso_8601": "2025-01-10T23:47:23.091472Z",
"url": "https://files.pythonhosted.org/packages/11/9a/f73e1fef99d86df9c8d506ea94cefbf95f20be897ba413e9d26c01ad4ae5/watchsync-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 23:47:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rlizana",
"github_project": "watchsync",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "watchsync"
}
JSON
