obsideo-cli 0.2.6__tar.gz → 0.2.7__tar.gz

{obsideo_cli-0.2.6 → obsideo_cli-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: obsideo-cli
-Version: 0.2.6
+Version: 0.2.7
 Summary: Obsideo Cloud - encrypted storage we can't read. Save, browse, and sync whatever you want, from your terminal.
 License: MIT
 Project-URL: Homepage, https://obsideo.io

{obsideo_cli-0.2.6 → obsideo_cli-0.2.7}/obsideo/cli.py

@@ -322,8 +322,16 @@ def run_login(url: str | None = None) -> bool:
 
 
 class ObsideoShell(cmd.Cmd):
-    intro = ("\n  Obsideo - encrypted storage we can't read.\n"
-             "  Type 'help' for commands, 'exit' to quit.\n")
+    intro = (
+        "\n  Obsideo - encrypted storage we can't read.\n\n"
+        "  Common commands:\n"
+        "    put <file> / get <name>     upload / download\n"
+        "    ls / cd / mkdir             browse your files\n"
+        "    sync push / pull / status   mirror your sync folder\n"
+        "    account                     your plan and usage\n"
+        "    about / faq / messages      learn more / team news\n\n"
+        "  Type 'help <command>' for details (e.g. 'help sync'), or 'exit' to quit.\n"
+    )
     prompt = "obsideo:/ "
 
     def __init__(self):

{obsideo_cli-0.2.6 → obsideo_cli-0.2.7}/obsideo/sync.py

@@ -1,129 +1,154 @@
-"""Sync a local folder with an Obsideo remote prefix (default 'sync/').
-
-Encrypts on push, decrypts on pull (account data key). Tracks state in a local
-manifest so unchanged files are skipped. Adapted from Cloud_Terminal's sync onto
-the Obsideo storage seam.
-"""
-
-import sys
-from pathlib import Path
-
-from obsideo_core import config, crypto, storage
-from obsideo import manifest
-
-REMOTE_PREFIX = "sync/"
-
-
-def _sync_dir() -> Path:
-    return Path(config.load_config().get("sync_dir", str(Path.home() / "obsideo-sync")))
-
-
-def ensure_sync_dir() -> Path:
-    """Return the sync folder, creating it if needed. Called on login and by every
-    sync command so a user never has to make the folder by hand — it just exists."""
-    sd = _sync_dir()
-    sd.mkdir(parents=True, exist_ok=True)
-    return sd
-
-
-def _remote_key(name: str) -> str:
-    return f"{REMOTE_PREFIX}{name}"
-
-
-def sync_status() -> dict:
-    sync_dir = ensure_sync_dir()
-    entries = manifest.get_all()
-    status = {"to_push": [], "to_pull": [], "synced": []}
-
-    local_files = {f.name: f for f in sync_dir.iterdir() if f.is_file()}
-
-    for name, f in local_files.items():
-        local_hash = manifest.file_sha256(f)
-        entry = entries.get(name)
-        if entry is None or entry.get("local_hash") != local_hash:
-            status["to_push"].append(name)
-        else:
-            status["synced"].append(name)
-
-    # Remote files we know about but don't have locally.
-    try:
-        remote = storage.list_prefix(REMOTE_PREFIX)
-        remote_names = {f["name"] for f in remote["files"]}
-    except Exception:
-        remote_names = set(entries.keys())
-    for name in remote_names:
-        if name not in local_files:
-            status["to_pull"].append(name)
-
-    return status
-
-
-def push(verbose: bool = True) -> int:
-    sync_dir = ensure_sync_dir()
-    files = [p for p in sync_dir.iterdir() if p.is_file()]
-    if not files:
-        if verbose:
-            print(f"  Your sync folder is empty:\n    {sync_dir}\n"
-                  f"  Drop files in there, then run `sync push` again.")
-        return 0
-
-    do_encrypt = config.load_config().get("encrypt", True)
-    entries = manifest.get_all()
-    pushed = 0
-
-    for f in files:
-        local_hash = manifest.file_sha256(f)
-        entry = entries.get(f.name)
-        if entry and entry.get("local_hash") == local_hash:
-            if verbose:
-                print(f"  {f.name} - unchanged, skipping")
-            continue
-
-        raw = f.read_bytes()
-        body = crypto.encrypt(raw) if do_encrypt else raw
-        try:
-            key = storage.put(_remote_key(f.name), body)
-            manifest.upsert(f.name, remote_key=key, local_hash=local_hash,
-                            size=len(raw), encrypted=do_encrypt)
-            pushed += 1
-            if verbose:
-                print(f"  {f.name} - uploaded")
-        except Exception as e:
-            print(f"  {f.name} - FAILED: {e}", file=sys.stderr)
-
-    return pushed
-
-
-def pull(verbose: bool = True) -> int:
-    sync_dir = ensure_sync_dir()
-
-    try:
-        remote = storage.list_prefix(REMOTE_PREFIX)
-    except Exception as e:
-        print(f"Failed to list remote: {e}", file=sys.stderr)
-        return 0
-
-    pulled = 0
-    for rf in remote["files"]:
-        name = rf["name"]
-        local_file = sync_dir / name
-        try:
-            blob = storage.get(rf["key"])
-            try:
-                raw = crypto.decrypt(blob)
-                encrypted = True
-            except Exception:
-                raw = blob  # was stored unencrypted
-                encrypted = False
-            local_file.parent.mkdir(parents=True, exist_ok=True)
-            local_file.write_bytes(raw)
-            manifest.upsert(name, remote_key=rf["key"],
-                            local_hash=manifest.file_sha256(local_file),
-                            size=len(raw), encrypted=encrypted)
-            pulled += 1
-            if verbose:
-                print(f"  {name} - downloaded")
-        except Exception as e:
-            print(f"  {name} - FAILED: {e}", file=sys.stderr)
-
-    return pulled
+"""Sync a local folder with an Obsideo remote prefix (default 'sync/').
+
+Encrypts on push, decrypts on pull (account data key). Tracks state in a local
+manifest so unchanged files are skipped. Adapted from Cloud_Terminal's sync onto
+the Obsideo storage seam.
+"""
+
+import sys
+from pathlib import Path
+
+from obsideo_core import config, crypto, storage
+from obsideo import manifest
+
+REMOTE_PREFIX = "sync/"
+
+# A local guide dropped in the sync folder so a user who opens it knows what it is
+# and how to use it. It is NEVER uploaded (push/status skip it).
+README_NAME = "READ ME - Obsideo sync.txt"
+_README_TEXT = """This is your Obsideo sync folder.
+
+Put files here, then back them up to your encrypted Obsideo storage from the CLI:
+
+    obsideo            open the app
+    sync push          upload new / changed files (encrypted on your device)
+    sync pull          download your files into this folder
+    sync status        see what's pending
+
+Everything is encrypted on your device before it leaves, so Obsideo cannot read
+it. In the CLI, type 'about' or 'faq' to learn more.
+
+(This file stays on your computer - it is not uploaded.)
+"""
+
+
+def _sync_dir() -> Path:
+    return Path(config.load_config().get("sync_dir", str(Path.home() / "obsideo-sync")))
+
+
+def ensure_sync_dir() -> Path:
+    """Return the sync folder, creating it if needed (and dropping a short READ ME
+    the first time). Called on login and by every sync command so a user never has
+    to make the folder by hand — it just exists, with instructions inside."""
+    sd = _sync_dir()
+    created = not sd.exists()
+    sd.mkdir(parents=True, exist_ok=True)
+    if created:
+        try:
+            (sd / README_NAME).write_text(_README_TEXT)
+        except OSError:
+            pass
+    return sd
+
+
+def _remote_key(name: str) -> str:
+    return f"{REMOTE_PREFIX}{name}"
+
+
+def sync_status() -> dict:
+    sync_dir = ensure_sync_dir()
+    entries = manifest.get_all()
+    status = {"to_push": [], "to_pull": [], "synced": []}
+
+    local_files = {f.name: f for f in sync_dir.iterdir() if f.is_file() and f.name != README_NAME}
+
+    for name, f in local_files.items():
+        local_hash = manifest.file_sha256(f)
+        entry = entries.get(name)
+        if entry is None or entry.get("local_hash") != local_hash:
+            status["to_push"].append(name)
+        else:
+            status["synced"].append(name)
+
+    # Remote files we know about but don't have locally.
+    try:
+        remote = storage.list_prefix(REMOTE_PREFIX)
+        remote_names = {f["name"] for f in remote["files"]}
+    except Exception:
+        remote_names = set(entries.keys())
+    for name in remote_names:
+        if name not in local_files:
+            status["to_pull"].append(name)
+
+    return status
+
+
+def push(verbose: bool = True) -> int:
+    sync_dir = ensure_sync_dir()
+    files = [p for p in sync_dir.iterdir() if p.is_file() and p.name != README_NAME]
+    if not files:
+        if verbose:
+            print(f"  Your sync folder is empty:\n    {sync_dir}\n"
+                  f"  Drop files in there, then run `sync push` again.")
+        return 0
+
+    do_encrypt = config.load_config().get("encrypt", True)
+    entries = manifest.get_all()
+    pushed = 0
+
+    for f in files:
+        local_hash = manifest.file_sha256(f)
+        entry = entries.get(f.name)
+        if entry and entry.get("local_hash") == local_hash:
+            if verbose:
+                print(f"  {f.name} - unchanged, skipping")
+            continue
+
+        raw = f.read_bytes()
+        body = crypto.encrypt(raw) if do_encrypt else raw
+        try:
+            key = storage.put(_remote_key(f.name), body)
+            manifest.upsert(f.name, remote_key=key, local_hash=local_hash,
+                            size=len(raw), encrypted=do_encrypt)
+            pushed += 1
+            if verbose:
+                print(f"  {f.name} - uploaded")
+        except Exception as e:
+            print(f"  {f.name} - FAILED: {e}", file=sys.stderr)
+
+    return pushed
+
+
+def pull(verbose: bool = True) -> int:
+    sync_dir = ensure_sync_dir()
+
+    try:
+        remote = storage.list_prefix(REMOTE_PREFIX)
+    except Exception as e:
+        print(f"Failed to list remote: {e}", file=sys.stderr)
+        return 0
+
+    pulled = 0
+    for rf in remote["files"]:
+        name = rf["name"]
+        local_file = sync_dir / name
+        try:
+            blob = storage.get(rf["key"])
+            try:
+                raw = crypto.decrypt(blob)
+                encrypted = True
+            except Exception:
+                raw = blob  # was stored unencrypted
+                encrypted = False
+            local_file.parent.mkdir(parents=True, exist_ok=True)
+            local_file.write_bytes(raw)
+            manifest.upsert(name, remote_key=rf["key"],
+                            local_hash=manifest.file_sha256(local_file),
+                            size=len(raw), encrypted=encrypted)
+            pulled += 1
+            if verbose:
+                print(f"  {name} - downloaded")
+        except Exception as e:
+            print(f"  {name} - FAILED: {e}", file=sys.stderr)
+
+    return pulled

{obsideo_cli-0.2.6 → obsideo_cli-0.2.7}/obsideo_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: obsideo-cli
-Version: 0.2.6
+Version: 0.2.7
 Summary: Obsideo Cloud - encrypted storage we can't read. Save, browse, and sync whatever you want, from your terminal.
 License: MIT
 Project-URL: Homepage, https://obsideo.io

{obsideo_cli-0.2.6 → obsideo_cli-0.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "obsideo-cli"
-version = "0.2.6"
+version = "0.2.7"
 description = "Obsideo Cloud - encrypted storage we can't read. Save, browse, and sync whatever you want, from your terminal."
 readme = "README.md"
 requires-python = ">=3.10"

{obsideo_cli-0.2.6 → obsideo_cli-0.2.7}/tests/test_cli.py

@@ -246,39 +246,52 @@ def test_update_check_windows_prints_command_not_pip(monkeypatch, capsys):
     err = capsys.readouterr().err
     assert ran == []  # never attempts the locked self-replace
     assert "pip install -U --no-cache-dir obsideo-cli" in err
+
+
+# ── sync auto-setup + info commands (0.2.6) ───────────────────────────────────
+
+def test_ensure_sync_dir_creates(tmp_path, monkeypatch):
+    from obsideo import sync
+    target = tmp_path / "mysync"
+    monkeypatch.setattr(sync, "_sync_dir", lambda: target)
+    assert not target.exists()
+    sd = sync.ensure_sync_dir()
+    assert sd == target and target.is_dir()  # auto-created, no manual mkdir
+
+
+def test_push_empty_folder_is_friendly_noop(tmp_path, monkeypatch, capsys):
+    from obsideo import sync
+    monkeypatch.setattr(sync, "_sync_dir", lambda: tmp_path / "s")
+    n = sync.push(verbose=True)
+    assert n == 0
+    out = capsys.readouterr().out.lower()
+    assert "empty" in out and "sync push" in out  # guides instead of erroring
+
+
+def test_about_and_faq_print(capsys):
+    sh = cli.ObsideoShell()
+    sh.do_about("")
+    sh.do_faq("")
+    out = capsys.readouterr().out
+    assert "OBSIDEO DRIVE" in out and "FAQ" in out and "obsideo-sync" in out
+
+
+def test_messages_handles_unreachable(monkeypatch, capsys):
+    def boom(*a, **k):
+        raise OSError("network down")
+    monkeypatch.setattr(cli.urllib.request, "urlopen", boom)
+    cli.ObsideoShell().do_messages("")
+    assert "couldn't reach" in capsys.readouterr().out.lower()
 
 
-# ── sync auto-setup + info commands (0.2.6) ───────────────────────────────────
-
-def test_ensure_sync_dir_creates(tmp_path, monkeypatch):
-    from obsideo import sync
-    target = tmp_path / "mysync"
-    monkeypatch.setattr(sync, "_sync_dir", lambda: target)
-    assert not target.exists()
-    sd = sync.ensure_sync_dir()
-    assert sd == target and target.is_dir()  # auto-created, no manual mkdir
-
-
-def test_push_empty_folder_is_friendly_noop(tmp_path, monkeypatch, capsys):
+def test_sync_readme_created_and_not_pushed(tmp_path, monkeypatch, capsys):
     from obsideo import sync
-    monkeypatch.setattr(sync, "_sync_dir", lambda: tmp_path / "s")
+    sd = tmp_path / "obsideo-sync"
+    monkeypatch.setattr(sync, "_sync_dir", lambda: sd)
+    sync.ensure_sync_dir()
+    readme = sd / sync.README_NAME
+    assert readme.exists() and "sync push" in readme.read_text()  # guide dropped in
+    # A folder containing ONLY the README is treated as empty (README never uploads).
     n = sync.push(verbose=True)
     assert n == 0
-    out = capsys.readouterr().out.lower()
-    assert "empty" in out and "sync push" in out  # guides instead of erroring
-
-
-def test_about_and_faq_print(capsys):
-    sh = cli.ObsideoShell()
-    sh.do_about("")
-    sh.do_faq("")
-    out = capsys.readouterr().out
-    assert "OBSIDEO DRIVE" in out and "FAQ" in out and "obsideo-sync" in out
-
-
-def test_messages_handles_unreachable(monkeypatch, capsys):
-    def boom(*a, **k):
-        raise OSError("network down")
-    monkeypatch.setattr(cli.urllib.request, "urlopen", boom)
-    cli.ObsideoShell().do_messages("")
-    assert "couldn't reach" in capsys.readouterr().out.lower()
+    assert "empty" in capsys.readouterr().out.lower()