Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

These docs describe unreleased changes on master. Read the latest stable documentation.

Python

Copy, remove, and reorganize files from Python, with typed results and streaming events. Synchronous and asyncio clients are available.

Install

The syq package on PyPI supports Python 3.13.4+ on Linux and macOS:

python -m pip install syq

Prebuilt wheels include the matching syq executable. Installation needs no Rust compiler, and SDK calls need no executable download or writable home directory for installation. The syq command is also available in the Python environment.

Installing from a source distribution builds the executable and requires Rust and a C compiler. Its remote behavior follows the native source version bundled in that distribution: source builds upload themselves to compatible SSH hosts by default. See source builds for helper selection and symbols when building from a checkout with those options. Older distributions retain their bundled native version’s build options.