pyftpsync icon indicating copy to clipboard operation
pyftpsync copied to clipboard

Synchronize directories using FTP(S), SFTP, or file system access.

logo pyftpsync

Build Status Latest Version License Documentation Status Code style: black Released with: Yabs StackOverflow: pyftpsync

Synchronize directories using FTP(S), SFTP, or file system access.

sample

Summary

Synchronize directories using FTP(S), SFTP, or file system access.

  • This is a command line tool...
  • ... and a library for use in your Python projects.
  • Upload, download, and bi-directional synch mode.
  • Allows FTP-to-FTP and Filesystem-to-Filesystem synchronization as well.
  • Architecture is open to add other target types.

Note: Version 4.0 drops support for Python 2.

Quickstart

Python 3.7+ is required, pip recommended:

$ pip install pyftpsync --upgrade
$ pyftpsync --help

Note:
MS Windows users that only need the command line interface may prefer the MSI Installer or install using the Windows Package Manager:

> winget install pyftpsync

See Command Line Interface for details.

In addition to the direct invocation of upload, download, or sync commands, version 3.x allows to define a pyftpsync_yaml file in your project's root folder which then can be executed like so::

$ pyftpsync run

See Run from pyftpsync.yaml for details.

Documentation

Read the Docs for details.