Python tool for Pythonista to synchronize local files with a Github repository hosted on a WebDav server.
The tool compares a local directory tree of Pythonista with a remote directory tree located on a WebDav server. It works very well (and sofar has only been tested with) the iOS app 'working copy'. The comparison is done by comparing the timestamps in both trees. New and updated files are transferred if required. So far there is no support for file deletion which should be done manually on both systems before synching. Synching of certain files can be suppressed using ignore files.
The tool can be called in GUI mode. The GUI offers additional functionality. Upon start it shows list of repositories configured for gitsynchista with their respective status.
The user selects entries from the list to either show a modfification summary for each repository
and trigger the synchronization. After synchronization the status will be updated automatically.
The GUI mode has special support for the iOS app working copy. If at least one repository is configured to be synchronized with the WebDAV server of working copy gitsynchista will activate the WebDAV server automatically by using published url-schemes of working copy. The main window will contain addtional elements to reflect the support (see below).
Also, the user will be able to open a selected repository in working copy directly from the gisynchista GUI by pressing a dedicated button (see screenhot above).
The GUI mode also has a special support for the Pythonista tool pyzipsta. When an installation of pyzipista is detected (this is basically done by checking if the script ../pyzipista/pyzipista.py exists with respect to the location of the script gitsynchista.py) the GUI starts up with an additional icon and an additional button (see next screenshot).
The border of the pyzipista button at the bottom of screen shows three different colors denoting the state of the respective self-extracting archive:
- black: The repository is not configured for pyzipista, which is to say there was no pyzipsita configuration file found in either the base directory of the repository or the
etcsubdirectory. - green: The repository is configured for pyzipista and the self-extracting archive is up-to-date.
- red: The repository is configured for pyzipista and the self-extracting archive is not up-to-date.
In the latter case the button is active and can be used to update the self-extracting archive.
You need to have the Python WebDav client installed. See my clone at https://github.com/marcus67/easywebdav. Place the scripts into the site-packages directory. And, of course, you need to have a WebDav server. I'm using the iOS app working copy but it should be possible to configure any other WebDAV server.
The source code is available as a self-extracting Python script. See file build/gitsynchista_zip.py. Download this file and follow the instructions contained therein.
The tool gitsynchista itself does not require any configuration. However, the user will have to provide a small configuration file for each repository which needs to be synchronized. In its simplest form (which applies to a local synchronization with working copy) the configuration can be as simple as follows:
[webdav] epoch_delta = 3600 [repository] name = SOME_LOGICAL_NAME local_path = ../LOCAL_DIRECTORY_NAME remote_path = /REMOTE_DIRECTORY_NAME
It should be placed in some sub directory (preferably etc) of the application to be synchronized. For a detailed description of the configuration file see the commented sample configuration file.
For feedback (bug reports) open an issue at GitHub. If you have questions about the tool see the Pythonista Forum.
Have fun!