Download the PHP package kmi/file-sync-tool without Composer
On this page you can find all versions of the php package kmi/file-sync-tool. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kmi/file-sync-tool
More information about kmi/file-sync-tool
Files in kmi/file-sync-tool
Package file-sync-tool
Short Description Python script to synchronize files from and to client systems.
License MIT
Homepage https://github.com/jackd248/file-sync-tool
Informations about the package file-sync-tool
file sync tool
Python script to synchronize files from an origin to a target system using rsync.
This tool is an addon of the db-sync-tool.
Installation
Prerequisite
The script needs python 3.5 or higher. It is necessary for some additional functionalities to have pip installed on your local machine.
pip
The library can be installed from PyPI:
composer
The script is also available via packagist.org using composer:
Additionally install the python requirements via the following pip command:
`
Configuration
You can configure the script with shell arguments or using a separate configuration file.
Configuration File
The config.json
contains important information about the origin and the target system.
Example structure of config.json
in receiver mode :
Documentation
Extend the config.json
with a files
section containing multiple transfer entries within the config
entry. Therefore you have to specify the origin
source path as well as the target
destination path of the file sync. Additionally define the rsync exclude
s for this specific transfer.
In the config
entry you can also define additional rsync option
s as a list overwriting the default options.
For further information see the documentation of the db-sync-tool.
Usage
Command line
Run the python script via command line.
Installed via pip:
Installed via composer:
Shell arguments
If you haven't declare a path to a SSH key, during the script execution you are requested to enter the SSH password for the given user in the shell argument or the config.json
to enable a SSH connection for the remote system.
Import
You can import the python package and use them inside your project:
Release Guide
A detailed guide is available to release a new version. See here.
Tests
A docker container set up is available for testing purpose. See here.