study-sync 1.0.3__tar.gz → 1.0.8__tar.gz

{study_sync-1.0.3 → study_sync-1.0.8}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: study_sync
-Version: 1.0.3
+Version: 1.0.8
 Summary: Offline-first, distributed workspace synchronisation CLI for developers.
-Author-email: Adinath <adinarayan.is23@bmsce.ac.in>
+Author-email: Malatesh <malateshbsunkad03@gmail.com>, Adinath <adinarayan.is23@bmsce.ac.in>
 License: MIT
 Project-URL: Homepage, https://github.com/yourusername/studysync
 Project-URL: Documentation, https://github.com/yourusername/studysync#readme

{study_sync-1.0.3 → study_sync-1.0.8}/README.md

@@ -1,101 +1,101 @@
-# StudySync
-
-**Offline-first, distributed workspace synchronisation for developers.**
-
-Share and sync files across laptops over a local network or the internet — with cryptographic integrity checking and conflict protection built in.
-
----
-
-## Install
-
-```bash
-pip install studysync
-```
-
-That's it. No environment setup, no config files, no server URL required.
-
----
-
-## Quick Start (2 steps)
-
-**Step 1 — Install**
-```bash
-pip install studysync
-```
-
-**Step 2 — Join a workspace with your token**
-```bash
-study join <TOKEN>
-```
-
-You'll receive a `<TOKEN>` from whoever created the workspace. After joining, pull all shared files straight to your current directory:
-
-```bash
-study pull
-```
-
----
-
-## Full Workflow
-
-### Create a workspace (team lead / project owner)
-```bash
-study workspace create my-project
-# Output includes a TOKEN — share it with your team
-```
-
-### Join an existing workspace (everyone else)
-```bash
-study join <TOKEN>
-study pull          # downloads all files into your current directory
-```
-
-### Push a file
-```bash
-study push path/to/file.py
-```
-
-If someone else pushed a newer version since your last pull, you'll see:
-
-```
-⚠  CONFLICT — Remote has changes. Pull first.
-```
-
-Pull, resolve, then push again.
-
-### Check sync status
-```bash
-study status
-```
-
-Shows `CLEAN`, `MODIFIED`, `DELETED`, or `UNTRACKED` for every file in your local workspace.
-
----
-
-## Self-Hosting
-
-Advanced users running their own StudySync backend can override the default server:
-
-```bash
-study join <TOKEN> --server https://my-backend.example.com
-```
-
-The URL is saved locally after the first use — subsequent commands pick it up automatically.
-
----
-
-## How It Works
-
-| Feature | Detail |
-|---|---|
-| **Integrity** | Every file is SHA-256 hashed before push and verified after pull |
-| **Conflict protection** | Optimistic Concurrency Control (OCC) — the server rejects a push if remote has a newer version |
-| **Offline-first** | Edits happen locally; the network is only touched on explicit `push` / `pull` |
-| **Zero-payload server** | File bytes stream directly between client and storage; the server only manages metadata |
-| **Silent history** | Every push is versioned server-side — no data is ever permanently overwritten |
-
----
-
-## License
-
-MIT © Adinath
+# StudySync
+
+**Offline-first, distributed workspace synchronisation for developers.**
+
+Share and sync files across laptops over a local network or the internet — with cryptographic integrity checking and conflict protection built in.
+
+---
+
+## Install
+
+```bash
+pip install studysync
+```
+
+That's it. No environment setup, no config files, no server URL required.
+
+---
+
+## Quick Start (2 steps)
+
+**Step 1 — Install**
+```bash
+pip install studysync
+```
+
+**Step 2 — Join a workspace with your token**
+```bash
+study join <TOKEN>
+```
+
+You'll receive a `<TOKEN>` from whoever created the workspace. After joining, pull all shared files straight to your current directory:
+
+```bash
+study pull
+```
+
+---
+
+## Full Workflow
+
+### Create a workspace (team lead / project owner)
+```bash
+study workspace create my-project
+# Output includes a TOKEN — share it with your team
+```
+
+### Join an existing workspace (everyone else)
+```bash
+study join <TOKEN>
+study pull          # downloads all files into your current directory
+```
+
+### Push a file
+```bash
+study push path/to/file.py
+```
+
+If someone else pushed a newer version since your last pull, you'll see:
+
+```
+⚠  CONFLICT — Remote has changes. Pull first.
+```
+
+Pull, resolve, then push again.
+
+### Check sync status
+```bash
+study status
+```
+
+Shows `CLEAN`, `MODIFIED`, `DELETED`, or `UNTRACKED` for every file in your local workspace.
+
+---
+
+## Self-Hosting
+
+Advanced users running their own StudySync backend can override the default server:
+
+```bash
+study join <TOKEN> --server https://my-backend.example.com
+```
+
+The URL is saved locally after the first use — subsequent commands pick it up automatically.
+
+---
+
+## How It Works
+
+| Feature | Detail |
+|---|---|
+| **Integrity** | Every file is SHA-256 hashed before push and verified after pull |
+| **Conflict protection** | Optimistic Concurrency Control (OCC) — the server rejects a push if remote has a newer version |
+| **Offline-first** | Edits happen locally; the network is only touched on explicit `push` / `pull` |
+| **Zero-payload server** | File bytes stream directly between client and storage; the server only manages metadata |
+| **Silent history** | Every push is versioned server-side — no data is ever permanently overwritten |
+
+---
+
+## License
+
+MIT © Adinath

{study_sync-1.0.3 → study_sync-1.0.8}/pyproject.toml

@@ -2,22 +2,17 @@
 requires = ["setuptools>=68.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
-# ---------------------------------------------------------------------------
-# Core metadata
-# ---------------------------------------------------------------------------
 [project]
 name = "study_sync"
-version = "1.0.3"
+version = "1.0.8"
 description = "Offline-first, distributed workspace synchronisation CLI for developers."
 license = { text = "MIT" }
 requires-python = ">=3.10"
 authors = [
-    { name = "Adinath", email = "adinarayan.is23@bmsce.ac.in" },
-]
-keywords = [
-    "sync", "cli", "workspace", "distributed",
-    "version-control", "developer-tools",
+     { name="Malatesh", email="malateshbsunkad03@gmail.com"},
+     { name = "Adinath", email = "adinarayan.is23@bmsce.ac.in" },
 ]
+keywords = ["sync", "cli", "workspace", "distributed", "version-control", "developer-tools"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Environment :: Console",
@@ -32,20 +27,12 @@ classifiers = [
     "Topic :: System :: Filesystems",
     "Topic :: Utilities",
 ]
-
-# ---------------------------------------------------------------------------
-# Runtime dependencies
-# ---------------------------------------------------------------------------
 dependencies = [
     "typer[all]>=0.12.0",
     "rich>=13.7.0",
     "requests>=2.31.0",
 ]
 
-# ---------------------------------------------------------------------------
-# Optional extras
-#   pip install studysync[dev]
-# ---------------------------------------------------------------------------
 [project.optional-dependencies]
 dev = [
     "pytest>=8.0.0",
@@ -55,24 +42,15 @@ dev = [
     "twine>=5.0.0",
 ]
 
-# ---------------------------------------------------------------------------
-# Entry point — makes `study` work as a global shell command
-# ---------------------------------------------------------------------------
 [project.scripts]
 study = "studysync.main:app"
 
-# ---------------------------------------------------------------------------
-# Project URLs shown on the PyPI landing page
-# ---------------------------------------------------------------------------
 [project.urls]
 Homepage      = "https://github.com/yourusername/studysync"
 Documentation = "https://github.com/yourusername/studysync#readme"
 "Bug Tracker" = "https://github.com/yourusername/studysync/issues"
 Changelog     = "https://github.com/yourusername/studysync/releases"
 
-# ---------------------------------------------------------------------------
-# Package discovery
-# ---------------------------------------------------------------------------
 [tool.setuptools.packages.find]
 where   = ["."]
 include = ["studysync*"]

{study_sync-1.0.3 → study_sync-1.0.8}/study_sync.egg-info/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: study_sync
-Version: 1.0.3
+Version: 1.0.8
 Summary: Offline-first, distributed workspace synchronisation CLI for developers.
-Author-email: Adinath <adinarayan.is23@bmsce.ac.in>
+Author-email: Malatesh <malateshbsunkad03@gmail.com>, Adinath <adinarayan.is23@bmsce.ac.in>
 License: MIT
 Project-URL: Homepage, https://github.com/yourusername/studysync
 Project-URL: Documentation, https://github.com/yourusername/studysync#readme

{study_sync-1.0.3 → study_sync-1.0.8}/studysync/__init__.py

@@ -1,3 +1 @@
 """StudySync CLI package."""
-
-__version__ = "0.1.0"

study_sync-1.0.8/studysync/constants.py

@@ -0,0 +1,3 @@
+"""Shared constants for the StudySync CLI."""
+
+PRODUCTION_SERVER_URL: str = "https://studysync-backend-pfft.onrender.com"

study_sync-1.0.8/studysync/local_state.py

@@ -0,0 +1,129 @@
+"""
+local_state.py — Manages all local CLI state.
+
+Directory layout
+----------------
+~/.study/
+    config.json          — active workspace credentials
+    manifest.json        — per-file {version, checksum} map
+    workspaces/
+        <workspace_name>/   — vault: local copies of synced files
+"""
+
+from __future__ import annotations
+
+import hashlib
+import json
+import shutil
+from pathlib import Path
+from typing import Any
+
+# ---------------------------------------------------------------------------
+# Directory constants
+# ---------------------------------------------------------------------------
+
+STUDY_DIR: Path = Path.home() / ".study"
+WORKSPACES_DIR: Path = STUDY_DIR / "workspaces"
+CONFIG_PATH: Path = STUDY_DIR / "config.json"
+MANIFEST_PATH: Path = STUDY_DIR / "manifest.json"
+
+
+# ---------------------------------------------------------------------------
+# Bootstrap
+# ---------------------------------------------------------------------------
+
+def ensure_dirs() -> None:
+    """Create ~/.study and ~/.study/workspaces/ if they don't exist."""
+    STUDY_DIR.mkdir(parents=True, exist_ok=True)
+    WORKSPACES_DIR.mkdir(parents=True, exist_ok=True)
+
+
+def workspace_root(workspace_name: str) -> Path:
+    """Return (and create) ~/.study/workspaces/<workspace_name>/."""
+    p = WORKSPACES_DIR / workspace_name
+    p.mkdir(parents=True, exist_ok=True)
+    return p
+
+
+# ---------------------------------------------------------------------------
+# Config
+# ---------------------------------------------------------------------------
+
+def load_config() -> dict[str, Any]:
+    """Load ~/.study/config.json; returns {} if missing or corrupt."""
+    if not CONFIG_PATH.exists():
+        return {}
+    try:
+        return json.loads(CONFIG_PATH.read_text(encoding="utf-8"))
+    except (json.JSONDecodeError, OSError):
+        return {}
+
+
+def save_config(data: dict[str, Any]) -> None:
+    """Persist config to ~/.study/config.json."""
+    ensure_dirs()
+    CONFIG_PATH.write_text(json.dumps(data, indent=2), encoding="utf-8")
+
+
+# ---------------------------------------------------------------------------
+# Manifest
+# ---------------------------------------------------------------------------
+
+def load_manifest() -> dict[str, dict[str, Any]]:
+    """
+    Load ~/.study/manifest.json.
+
+    Schema: {file_path: {version: int, checksum: str}}
+    """
+    if not MANIFEST_PATH.exists():
+        return {}
+    try:
+        return json.loads(MANIFEST_PATH.read_text(encoding="utf-8"))
+    except (json.JSONDecodeError, OSError):
+        return {}
+
+
+def save_manifest(data: dict[str, dict[str, Any]]) -> None:
+    """Persist manifest to ~/.study/manifest.json."""
+    ensure_dirs()
+    MANIFEST_PATH.write_text(json.dumps(data, indent=2), encoding="utf-8")
+
+
+def update_manifest_entry(file_path: str, version: int, checksum: str) -> None:
+    """Update a single entry in the manifest without touching others."""
+    manifest = load_manifest()
+    manifest[file_path] = {"version": version, "checksum": checksum}
+    save_manifest(manifest)
+
+
+# ---------------------------------------------------------------------------
+# Vault helpers
+# ---------------------------------------------------------------------------
+
+def local_file_path(workspace_name: str, file_path: str) -> Path:
+    """Return the vault path for a given workspace file."""
+    return WORKSPACES_DIR / workspace_name / file_path
+
+
+def all_local_files(workspace_name: str) -> list[Path]:
+    """
+    Return every file currently in the vault for this workspace.
+    Paths are relative to the vault root.
+    """
+    root = WORKSPACES_DIR / workspace_name
+    if not root.exists():
+        return []
+    return [p for p in root.rglob("*") if p.is_file()]
+
+
+# ---------------------------------------------------------------------------
+# Hashing
+# ---------------------------------------------------------------------------
+
+def sha256_file(path: Path) -> str:
+    """Return the hex SHA-256 digest of *path* using 64 KiB streaming reads."""
+    h = hashlib.sha256()
+    with open(path, "rb") as fh:
+        for chunk in iter(lambda: fh.read(65_536), b""):
+            h.update(chunk)
+    return h.hexdigest()