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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: obsideo-cli
-Version: 0.2.5
+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.5 → obsideo_cli-0.2.7}/obsideo/cli.py

@@ -310,13 +310,28 @@ def run_login(url: str | None = None) -> bool:
         print("Note: storage activation is finishing rollout; if an upload fails, retry shortly.")
     print("Your files are encrypted with a local key. Back it up:")
     print(f"  {crypto.DATA_KEY_FILE}")
+    # Create the sync folder now so it's ready (never make the user mkdir it).
+    try:
+        from obsideo import sync as _sync
+        sd = _sync.ensure_sync_dir()
+        print(f"Your sync folder is ready (drop files here, then `sync push`):\n  {sd}")
+    except Exception:
+        pass
     print("Type 'obsideo' to open the shell, or 'obsideo put <file>' to store something.")
     return True
 
 
 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):
@@ -541,27 +556,105 @@ class ObsideoShell(cmd.Cmd):
 
     # ── account ───────────────────────────────────────────────────────────────
     def do_account(self, arg):
-        """Show your plan: storage used vs. your free quota."""
+        """Show your account: plan, storage used, and where your files/keys live."""
         if not self._require_login():
             return
-        usage = _fetch_usage()
+        from obsideo import sync as sync_mod
         print()
         print("  -- Obsideo account --------------------------")
         print("     Plan:  Free")
-        if usage:
-            used, quota = usage["used_bytes"], usage["quota_bytes"]
-            pct = usage.get("percent_used", (used / quota if quota else 0))
-            print(f"     Used:  {_human(used)} / {_human(quota)} ({pct*100:.1f}%)")
-            bar_len = 30
-            filled = int(bar_len * min(pct, 1.0))
-            print(f"     [{'#'*filled}{'-'*(bar_len-filled)}]")
-            if pct >= 0.8:
-                print("     You're near your limit - reply to any Obsideo email to upgrade.")
+        if not config.account_token():
+            # No shim token (e.g. creds set via env / pre-login account): we can't
+            # query usage. Don't claim the service is down — tell them how to link it.
+            print("     Usage: sign in with `obsideo login` to see usage details")
         else:
-            print("     (usage unavailable - is the account service reachable?)")
+            usage = _fetch_usage()
+            if usage:
+                used, quota = usage["used_bytes"], usage["quota_bytes"]
+                pct = usage.get("percent_used", (used / quota if quota else 0))
+                print(f"     Used:  {_human(used)} / {_human(quota)} ({pct*100:.1f}%)")
+                bar_len = 30
+                filled = int(bar_len * min(pct, 1.0))
+                print(f"     [{'#'*filled}{'-'*(bar_len-filled)}]")
+                if pct >= 0.8:
+                    print("     You're near your limit - reply to any Obsideo email to upgrade.")
+            else:
+                print("     Usage: couldn't reach the account service - try again shortly")
+        print(f"     Files: bucket '{storage.bucket()}'  ·  sync folder {sync_mod.ensure_sync_dir()}")
+        print(f"     Keys:  {config.CONFIG_DIR}  (back up data.key)")
         print("  ---------------------------------------------")
         print()
 
+    # ── about / faq / messages ────────────────────────────────────────────────
+    def do_about(self, arg):
+        """What Obsideo is."""
+        print("""
+  OBSIDEO DRIVE - encrypted storage we can't read.
+
+  Your files are encrypted on your device (AES-256-GCM) before they ever leave
+  it, then stored across three independent providers (RF=3). Obsideo's servers
+  only ever see ciphertext - never your filenames, never your data.
+
+  - Free: 3 GB, no card, no expiry.
+  - Your keys live only on your machine (~/.obsideo). Back up data.key - lose it
+    and the data is unrecoverable by design. That's the point: not even we can read it.
+  - Install / update:  pip install -U obsideo-cli      More:  https://obsideo.io
+""")
+
+    def do_faq(self, arg):
+        """Frequently asked questions."""
+        print("""
+  -- Obsideo FAQ --
+
+  Q: Can Obsideo read my files?
+  A: No. They're encrypted on your device before upload; we only store ciphertext.
+
+  Q: What's free?
+  A: 3 GB, no credit card, no expiry.
+
+  Q: What if I lose my key?
+  A: Your key is ~/.obsideo/data.key - back it up. Without it the data can't be
+     decrypted by anyone, including us.
+
+  Q: Two folders - what's the difference?
+  A: ~/.obsideo  = your keys + settings (don't touch).
+     ~/obsideo-sync = your SYNC folder - files you put here sync with `sync push`.
+
+  Q: What does `sync` do?
+  A: Mirrors your sync folder to/from the cloud. `sync push` uploads new/changed
+     files, `sync pull` downloads, `sync status` shows what's pending. It's manual
+     (you run it) and covers files in the top of the folder.
+
+  Q: How do I change settings (sync folder, encryption)?
+  A: `config` shows them; `config set sync_dir <path>` / `config set encrypt_names false`.
+
+  Q: More space?
+  A: Reply to any Obsideo email to upgrade. (A referral program is coming.)
+
+  Q: Updating?
+  A: pip install -U obsideo-cli  - the CLI also nudges you when an update is out.
+""")
+
+    def do_messages(self, arg):
+        """Messages from the Obsideo team."""
+        try:
+            req = urllib.request.Request(
+                f"{config.signup_url()}/v1/notices",
+                headers={"User-Agent": config.USER_AGENT},
+            )
+            with urllib.request.urlopen(req, timeout=10, context=config.ssl_context()) as resp:
+                notices = json.loads(resp.read().decode()).get("notices", [])
+        except Exception:
+            print("\n  Couldn't reach the message service - try again shortly.\n")
+            return
+        if not notices:
+            print("\n  No messages from the Obsideo team right now.\n")
+            return
+        print("\n  -- Messages from the Obsideo team --")
+        for n in notices:
+            print(f"   - {n.get('body', '').strip()}")
+        print()
+
     # ── sync ──────────────────────────────────────────────────────────────────
     def do_sync(self, arg):
         """Sync your local folder with Obsideo. Usage: sync push|pull|status"""

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

@@ -1,122 +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 _remote_key(name: str) -> str:
-    return f"{REMOTE_PREFIX}{name}"
-
-
-def sync_status() -> dict:
-    sync_dir = _sync_dir()
-    entries = manifest.get_all()
-    status = {"to_push": [], "to_pull": [], "synced": []}
-
-    local_files = {}
-    if sync_dir.exists():
-        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 = _sync_dir()
-    if not sync_dir.exists():
-        if verbose:
-            print(f"Sync folder does not exist: {sync_dir}")
-        return 0
-
-    do_encrypt = config.load_config().get("encrypt", True)
-    entries = manifest.get_all()
-    pushed = 0
-
-    for f in (p for p in sync_dir.iterdir() if p.is_file()):
-        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 = _sync_dir()
-    sync_dir.mkdir(parents=True, exist_ok=True)
-
-    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.5 → 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.5
+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.5 → obsideo_cli-0.2.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "obsideo-cli"
-version = "0.2.5"
+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.5 → obsideo_cli-0.2.7}/tests/test_cli.py

@@ -246,3 +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()
+
+
+def test_sync_readme_created_and_not_pushed(tmp_path, monkeypatch, capsys):
+    from obsideo import sync
+    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
+    assert "empty" in capsys.readouterr().out.lower()