ryt / psync

Python command line tool to manage multiple sites/apps/files with rsync.

Psync

Psync (inspired by grsync) makes it easy to use rsync with multiple apps/sites.

Just edit the config file (psync.ini) and add your local and remote paths. Give each app or project a short name and you're done.

Usage

Normal sync -a:

psync railsapp
psync myfile

Sync but delete extraneous files -d:

psync railsapp -d

Show the rsync command and exit -s or -c:

psync railsapp -s
psync railsapp -c

List all the apps (or files) that you've added alphabetically -l or --list:

psync (-l|--list)

The output should be something like this:

myapp       /home/myapp/        serverhost:/home/myapp/
myfile      /home/myfile.php    user@1.1.1.1:/home/myfile.php
railsapp    /home/me/railsapp/  [e-mail]:/home/railsapp/

Setup

In the examples below, the command used is psync. You can create an alias, for example push, if you want to do that. If you don't know how, read to the end.

Add your local and remote paths by editing psync.ini:

[list]
railsapp = /home/me/railsapp/    [e-mail]:/home/railsapp/

If both your local and remote paths are identical, use the keyword :same in the remote value:

[list]
myfile = /home/myfile.php   user@1.1.1.1:same
myapp  = /home/myapp/       serverhost:same

You can escape spaces in path names using a backslash (e.g. my\ file).

Substitutions

You can make substitutions to the list of path names by using the [replace] section. Use the key for your pattern and value for your replacement. The patterns will be parsed as strings and not regular expressions. If you'd like, you can use any symbol (e.g. $) to differentiate the replacement keys.

[replace]
$longpath = /home/clients/ray/projects/2024-01-01/long/path/to/apps
$another  = /home/another/substitution/for/projects

# use the above keys instead of long path names in the list below:

[list]
djlite = $longpath/django-lite     user@1.1.1.1:/srv/projects/django-lite
myapp  = $another/myfile.php       serverhost:/var/www/projects/myfile.php

Excludes

You can exclude certain directories and files by using exclude in the [settings] section:

[settings]
exclude = .git/ .DS_Store

Config file option

To specify a custom file path for the config file, use the -f or --conf option:

psync -f /path/to/psync.ini railsapp

or

psync --conf=/path/to/psync.ini railsapp

By default, the script looks for the config file in your current working directory. The above option will override the default.

Alias with psync or push

To acess psync.py with psync add the following to .bashrc or .profile on Mac:

alias psync='/path/to/psync.py'

To access it with push simply name the alias push :)

alias push='/path/to/psync.py'

Note: you may encounter errors if you use the short ~/path versions of files or directories in your alias. To prevent any errors, use the full path starting with /path.

To specify a custom config file path with push use the -f or --conf option:

alias push='/path/to/psync.py --conf=/path/to/psync.ini'

Final note: if you want to specify additional rsync options when you run psync, run the show command and exit with -s or -c and add your options accordingly when running the rsync command.

Notes

The current version of psync has been tested successfully on Python 3.8 and above. If you have older versions of Python, you may need to make slight modifications to the script to make it compatible.

_{Copyright © 2024 Ray Mentose.}