LiveSync 0.2.2__py3-none-any.whl → 0.3.0__py3-none-any.whl

{LiveSync-0.2.2.dist-info → LiveSync-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LiveSync
-Version: 0.2.2
+Version: 0.3.0
 Summary: Repeatedly synchronize local workspace with a (slow) remote machine
 Home-page: https://github.com/zauberzeug/livesync
 Author: Zauberzeug GmbH
@@ -10,8 +10,9 @@ Keywords: sync remote watch filesystem development deploy live hot reload
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: watchfiles
 Requires-Dist: pathspec
+Requires-Dist: pyjson5
+Requires-Dist: watchfiles
 
 # LiveSync
 
@@ -35,28 +36,38 @@ It works best if you have some kind of reload mechanism in place on the target (
 ## Usage
 
 ```bash
-cd <my_project_folder>
-livesync <username>@<host>
+livesync <source> <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.
 
+Positional arguments:
+
+- `<source>`
+  local folder or VSCode workspace file
+- `<username>@<host>`
+  target user and host (e.g. username@hostname)
+
+Options:
+
+- `--target-root TARGET_ROOT`
+  subfolder on target to synchronize to (default: "")
+- `--target-port TARGET_PORT`
+  SSH port on target (default: 22)
+- `--on-change ON_CHANGE`
+  command to be executed on remote host after any file change (default: None)
+- `--mutex-interval MUTEX_INTERVAL`
+  interval in which mutex is updated (default: 10 seconds)
+
 ### Notes
 
 - We suggest you have some auto-reloading in place on the (slow) target machine, like [NiceGUI](https://nicegui.io).
 - 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
+- If a `.syncignore` file doesn't exist, it is automatically created containing `.git/`, `__pycache__/`, `.DS_Store`, `*.tmp`, and `.env`.
+- If you pass a VSCode workspace file as `source`, LiveSync will synchronize each directory listed in the `folders` section.
 
 ## Installation
 

LiveSync-0.3.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+livesync/__init__.py,sha256=V9nt0JRzIeiiLDVNDMZ20SqLMSqFh8uPViPsp2WYK6g,60
+livesync/folder.py,sha256=NhorutBdi6_0bhLCPjrVi8TIPZ3TPDQxJRQ0L0-3kRU,3619
+livesync/livesync.py,sha256=PKaw-WD4WOZb-X2n4ihj0C8jEOff4s5dopOGiOM3xI4,2586
+livesync/mutex.py,sha256=C3Az3Exfgj1ohKnhWl77TDvuJlv3q2qieSgtJF__Wdc,1646
+LiveSync-0.3.0.dist-info/LICENSE,sha256=QcBlwggRQYhvfTAE481AAMFQfMS_N6Bj8Svh1T6dsnI,1072
+LiveSync-0.3.0.dist-info/METADATA,sha256=pjVKS1x7LaYr_emVuhAwMUIQyK-WKxJYzPUhnVMs9fc,4285
+LiveSync-0.3.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+LiveSync-0.3.0.dist-info/entry_points.txt,sha256=4dn5YR27lUlJWea3yqLKLqR4MwqjcqzMR5Q4jVFnytI,52
+LiveSync-0.3.0.dist-info/top_level.txt,sha256=mLwExc6wTUGqxvUkYMio5rxGS1h8bvxpNsR2ebfjSL4,9
+LiveSync-0.3.0.dist-info/RECORD,,

livesync/folder.py

@@ -9,6 +9,7 @@ import pathspec
 import watchfiles
 
 KWONLY_SLOTS = {'kw_only': True, 'slots': True} if sys.version_info >= (3, 10) else {}
+DEFAULT_IGNORES = ['.git/', '__pycache__/', '.DS_Store', '*.tmp', '.env']
 
 
 def run_subprocess(command: str, *, quiet: bool = False) -> None:
@@ -36,7 +37,7 @@ class Folder:
 
         # from https://stackoverflow.com/a/22090594/3419103
         match_pattern = pathspec.patterns.gitwildmatch.GitWildMatchPattern
-        self._ignore_spec = pathspec.PathSpec.from_lines(match_pattern, self.get_excludes())
+        self._ignore_spec = pathspec.PathSpec.from_lines(match_pattern, self.get_ignores())
 
         self._stop_watching = asyncio.Event()
 
@@ -48,17 +49,11 @@ class Folder:
     def ssh_path(self) -> str:
         return f'{self.target.host}:{self.target_path}'
 
-    def get_excludes(self) -> List[str]:
-        return ['.git/', '__pycache__/', '.DS_Store', '*.tmp', '.env'] + \
-            self._parse_ignore_file(self.local_path / '.syncignore') + \
-            self._parse_ignore_file(self.local_path / '.gitignore')
-
-    @staticmethod
-    def _parse_ignore_file(path: Path) -> List[str]:
+    def get_ignores(self) -> List[str]:
+        path = self.local_path / '.syncignore'
         if not path.is_file():
-            return []
-        with path.open() as f:
-            return [line.strip() for line in f.readlines() if not line.startswith('#')]
+            path.write_text('\n'.join(DEFAULT_IGNORES))
+        return [line.strip() for line in path.read_text().splitlines() if not line.startswith('#')]
 
     def get_summary(self) -> str:
         summary = f'{self.local_path} --> {self.ssh_path}\n'
@@ -90,7 +85,7 @@ class Folder:
     def sync(self, post_sync_command: Optional[str] = None) -> None:
         args = '--prune-empty-dirs --delete -avz --checksum --no-t'
         # args += ' --mkdirs'  # INFO: this option is not available in rsync < 3.2.3
-        args += ''.join(f' --exclude="{e}"' for e in self.get_excludes())
+        args += ''.join(f' --exclude="{e}"' for e in self.get_ignores())
         args += f' -e "ssh -p {self.target.port}"'
         run_subprocess(f'rsync {args} {self.local_path}/ {self.ssh_path}/', quiet=True)
         if post_sync_command:

livesync/livesync.py

@@ -1,11 +1,12 @@
 #!/usr/bin/env python3
 import argparse
 import asyncio
-import json
 import sys
 from pathlib import Path
 from typing import List
 
+import pyjson5
+
 from livesync import Folder, Mutex, Target
 
 
@@ -14,37 +15,31 @@ def git_summary(folders: List[Folder]) -> str:
 
 
 async def async_main() -> None:
-    parser = argparse.ArgumentParser(description='Repeatedly synchronize local workspace with remote machine')
-    parser.add_argument('--on-change', type=str, help='command to be executed on remote host after any file change')
-    parser.add_argument('--source', type=str, help='source folder on local host instead of VSCode workspace file')
-    parser.add_argument('--mutex-interval', type=int, default=10, help='interval in which mutex is updated')
+    parser = argparse.ArgumentParser(
+        description='Repeatedly synchronize local directories with remote machine',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument('source', type=str, help='local source folder or VSCode workspace file')
     parser.add_argument('--target-root', type=str, default='', help='subfolder on target to synchronize to')
     parser.add_argument('--target-port', type=int, default=22, help='SSH port on target')
+    parser.add_argument('--on-change', type=str, help='command to be executed on remote host after any file change')
+    parser.add_argument('--mutex-interval', type=int, default=10, help='interval in which mutex is updated')
     parser.add_argument('host', type=str, help='the target host (e.g. username@hostname)')
     args = parser.parse_args()
+    source = Path(args.source)
     target = Target(host=args.host, port=args.target_port, root=Path(args.target_root))
 
     folders: List[Folder] = []
-    workspaces = list(Path.cwd().glob('*.code-workspace'))
-    if args.source is None and workspaces:
-
-        if len(workspaces) > 1:
-            print('Multiple VSCode workspace files found.')
-            print('Provide --source argument or run livesync in a directory with a single *.code-workspace file.')
-            sys.exit(1)
-
-        print(f'Reading VSCode workspace file {workspaces[0]}...')
-
-        workspace = json.loads(workspaces[0].read_text())
+    if source.is_file():
+        workspace = pyjson5.decode(source.read_text())
         paths = [Path(f['path']) for f in workspace['folders']]
         folders = [Folder(p, target) for p in paths if p.is_dir()]
     else:
-        source_path = Path(args.source or '.')
-        if not source_path.is_dir():
-            print(f'Invalid source path: {source_path}')
-            sys.exit(1)
+        folders = [Folder(source, target)]
 
-        folders = [Folder(source_path, target)]
+    for folder in folders:
+        if not folder.local_path.is_dir():
+            print(f'Invalid path: {folder.local_path}')
+            sys.exit(1)
 
     print('Checking mutex...')
     mutex = Mutex(target)

LiveSync-0.2.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-livesync/__init__.py,sha256=V9nt0JRzIeiiLDVNDMZ20SqLMSqFh8uPViPsp2WYK6g,60
-livesync/folder.py,sha256=-LlFfZCvtTc_fPOyRCsFLaH1zIwgVo62QgYCRV4ELP4,3774
-livesync/livesync.py,sha256=g2rNyVDkwksr_9yKBcpxIJmu_iQCvlSZFGRcGw_UtfM,2895
-livesync/mutex.py,sha256=C3Az3Exfgj1ohKnhWl77TDvuJlv3q2qieSgtJF__Wdc,1646
-LiveSync-0.2.2.dist-info/LICENSE,sha256=QcBlwggRQYhvfTAE481AAMFQfMS_N6Bj8Svh1T6dsnI,1072
-LiveSync-0.2.2.dist-info/METADATA,sha256=fq3iID0leIkx9zWyZgkQ9-N72Ff7iGYR4SQxTnNPodc,4031
-LiveSync-0.2.2.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-LiveSync-0.2.2.dist-info/entry_points.txt,sha256=4dn5YR27lUlJWea3yqLKLqR4MwqjcqzMR5Q4jVFnytI,52
-LiveSync-0.2.2.dist-info/top_level.txt,sha256=mLwExc6wTUGqxvUkYMio5rxGS1h8bvxpNsR2ebfjSL4,9
-LiveSync-0.2.2.dist-info/RECORD,,