livesync 0.2.2

Repeatedly synchronize local workspace with a (slow) remote machine

LiveSync

Repeatedly synchronize local workspace with a (slow) remote machine. It is available as PyPI package and hosted on GitHub.

Use Case

VS Code Remote Development and similar tools are great as long as your remote machine is powerful enough. But if your target is a Raspberry Pi, Jetson Nano/Xavier/Orin, Beagle Board or similar, it feels like coding in jelly. Especially if you run powerful extensions like Pylance. LiveSync solves this by watching your code for changes and just copying the modifications to the slow remote machine. It works best if you have some kind of reload mechanism in place on the target (NiceGUI, FastAPI or Flask for example).

Usage

cd <my_project_folder>
livesync <username>@<host>

LiveSync uses rsync (SSH) to copy the files, so the <username>@<host> must be accessible via SSH (ideally by key, not password or passphrase, because it will be called over and over).

Press CTRL-C to abort the synchronization.

Notes

• We suggest you have some auto-reloading in place on the (slow) target machine, like NiceGUI.
• Only one user per target host should run LiveSync at a time. Therefore LiveSync provides a mutex mechanism.
• By default .git/ folders are not synchronized.
• All files and directories from the .gitignore of any source directory are also excluded from synchronization.
• You can create a .syncignore file in any source directory to skip additional files and directories from syncing.
• If LiveSync finds a VSCode workspace file, it will synchronize each directory listed in the folders section.

Options

• --on-change [command] command to be executed on remote host after any file change
• --source [SOURCE] source folder on local host instead of VSCode workspace file
• --mutex-interval [INTERVAL] interval for updating the mutex

Installation

python3 -m pip install livesync

Development

For development we suggest to use the following instructions instead of the normal pip installation:

git clone [e-mail]:zauberzeug/livesync.git
cd livesync
python3 -m pip uninstall livesync # remove previous installed version
python3 -m pip install -e .

Now you can change the code and call the livesync command from your $PATH variable with the modified code.

Testing

We have build a small testing infrastructure with two docker containers. See tests/README.md for details.

Releases

Just create and push a new tag with the new version name (v0.2.1 for example). After a successful build a new release will be created. This should be edited to describe the changes in the release notes.