wirez-py 1.0.0__py3-none-any.whl

wires/__init__.py

@@ -0,0 +1,37 @@
+"""
+wires — remember and retrieve file paths by name.
+"""
+
+from .registry import save, remember, get, recall, remove, list_all, path
+from .debug import enable_debug, enable_warnings
+
+__all__ = [
+    "save", "remember",
+    "get", "recall",
+    "remove", "list_all", "path",
+    "enable_debug", "enable_warnings",
+]
+
+print(r"""
+         _____                    _____                    _____                    _____                    _____
+        /\    \                  /\    \                  /\    \                  /\    \                  /\    \
+       /::\____\                /::\    \                /::\    \                /::\    \                /::\    \
+      /:::/    /                \:::\    \              /::::\    \              /::::\    \              /::::\    \
+     /:::/   _/___               \:::\    \            /::::::\    \            /::::::\    \            /::::::\    \
+    /:::/   /\    \               \:::\    \          /:::/\:::\    \          /:::/\:::\    \          /:::/\:::\    \
+   /:::/   /::\____\               \:::\    \        /:::/__\:::\    \        /:::/__\:::\    \        /:::/__\:::\    \
+  /:::/   /:::/    /               /::::\    \      /::::\   \:::\    \      /::::\   \:::\    \       \:::\   \:::\    \
+ /:::/   /:::/   _/___    ____    /::::::\    \    /::::::\   \:::\    \    /::::::\   \:::\    \    ___\:::\   \:::\    \
+/:::/___/:::/   /\    \  /\   \  /:::/\:::\    \  /:::/\:::\   \:::\____\  /:::/\:::\   \:::\    \  /\   \:::\   \:::\    \
+|:::|   /:::/   /::\____\/::\   \/:::/  \:::\____\/:::/  \:::\   \:::|    |/:::/__\:::\   \:::\____\/::\   \:::\   \:::\____\
+|:::|__/:::/   /:::/    /\:::\  /:::/    \::/    /\::/   |::::\  /:::|____|\:::\   \:::\   \::/    /\:::\   \:::\   \::/    /
+ \:::\/:::/   /:::/    /  \:::\/:::/    / \/____/  \/____|:::::\/:::/    /  \:::\   \:::\   \/____/  \:::\   \:::\   \/____/
+  \::::::/   /:::/    /    \::::::/    /                 |:::::::::/    /    \:::\   \:::\    \       \:::\   \:::\    \
+   \::::/___/:::/    /      \::::/____/                  |::|\::::/    /      \:::\   \:::\____\       \:::\   \:::\____\
+    \:::\__/:::/    /        \:::\    \                  |::| \::/____/        \:::\   \::/    /        \:::\  /:::/    /
+     \::::::::/    /          \:::\    \                 |::|  ~|               \:::\   \/____/          \:::\/:::/    /
+      \::::::/    /            \:::\    \                |::|   |                \:::\    \               \::::::/    /
+       \::::/    /              \:::\____\               \::|   |                 \:::\____\               \::::/    /
+        \::/____/                \::/    /                \:|   |                  \::/    /                \::/    /
+         ~~                       \/____/                  \|___|                   \/____/                  \/____/
+""")

wires/debug.py

@@ -0,0 +1,47 @@
+import os
+import sys
+
+_debug_enabled = False
+_warn_enabled = True
+
+RESET  = "\033[0m"
+YELLOW = "\033[93m"
+RED    = "\033[91m"
+CYAN   = "\033[96m"
+GREEN  = "\033[92m"
+BOLD   = "\033[1m"
+
+_SUPPORTS_COLOR = hasattr(sys.stdout, "isatty") and sys.stdout.isatty()
+
+
+def _color(code: str, text: str) -> str:
+    return f"{code}{text}{RESET}" if _SUPPORTS_COLOR else text
+
+
+def enable_debug(on: bool = True) -> None:
+    global _debug_enabled
+    _debug_enabled = on
+
+
+def enable_warnings(on: bool = True) -> None:
+    global _warn_enabled
+    _warn_enabled = on
+
+
+def log(msg: str) -> None:
+    if _debug_enabled:
+        print(_color(CYAN, f"[wires debug] {msg}"), file=sys.stderr)
+
+
+def warn(msg: str) -> None:
+    if _warn_enabled:
+        print(_color(YELLOW, f"[wires warn]  {msg}"), file=sys.stderr)
+
+
+def error(msg: str) -> None:
+    print(_color(RED, f"[wires error] {msg}"), file=sys.stderr)
+
+
+def ok(msg: str) -> None:
+    if _debug_enabled:
+        print(_color(GREEN, f"[wires ok]    {msg}"), file=sys.stderr)

wires/registry.py

@@ -0,0 +1,94 @@
+import json
+import os
+from pathlib import Path
+from . import debug as _dbg
+
+_REGISTRY_DIR = Path.home() / ".wires"
+_REGISTRY_FILE = _REGISTRY_DIR / "registry.json"
+
+
+def _load() -> dict:
+    if not _REGISTRY_FILE.exists():
+        _dbg.log(f"Registry not found at {_REGISTRY_FILE}, starting empty")
+        return {}
+    with open(_REGISTRY_FILE, "r", encoding="utf-8") as f:
+        data = json.load(f)
+    _dbg.log(f"Loaded registry ({len(data)} entries)")
+    return data
+
+
+def _dump(data: dict) -> None:
+    _REGISTRY_DIR.mkdir(parents=True, exist_ok=True)
+    with open(_REGISTRY_FILE, "w", encoding="utf-8") as f:
+        json.dump(data, f, indent=2)
+    _dbg.log(f"Registry saved to {_REGISTRY_FILE}")
+
+
+def save(name: str, file_path: str | os.PathLike) -> None:
+    """Register a file path under a name."""
+    resolved = str(Path(file_path).resolve())
+
+    data = _load()
+
+    if name in data:
+        _dbg.warn(f"'{name}' already exists ({data[name]}) — overwriting with {resolved}")
+    else:
+        _dbg.log(f"Registering new wire: '{name}' → {resolved}")
+
+    if not Path(resolved).exists():
+        _dbg.warn(f"The file '{resolved}' does not exist on disk — saving path anyway")
+
+    data[name] = resolved
+    _dump(data)
+    _dbg.ok(f"Saved '{name}'")
+
+
+# alias
+remember = save
+
+
+def get(name: str) -> str:
+    """Return the path string registered under name."""
+    data = _load()
+    if name not in data:
+        _dbg.error(f"No wire named '{name}' — available: {list(data.keys())}")
+        raise KeyError(f"No wire named '{name}'")
+
+    result = data[name]
+    _dbg.log(f"Retrieved '{name}' → {result}")
+
+    if not Path(result).exists():
+        _dbg.warn(f"Wire '{name}' points to '{result}' which no longer exists on disk")
+
+    return result
+
+
+# alias
+recall = get
+
+
+def path(name: str) -> Path:
+    """Return the registered path as a pathlib.Path."""
+    return Path(get(name))
+
+
+def remove(name: str) -> None:
+    """Unregister a name."""
+    data = _load()
+    if name not in data:
+        _dbg.error(f"Cannot remove '{name}' — not found. Available: {list(data.keys())}")
+        raise KeyError(f"No wire named '{name}'")
+    old = data.pop(name)
+    _dump(data)
+    _dbg.ok(f"Removed '{name}' (was → {old})")
+
+
+def list_all() -> dict[str, str]:
+    """Return a copy of all registered name→path mappings."""
+    data = _load()
+    _dbg.log(f"Listing all wires: {list(data.keys())}")
+    # warn about any stale paths
+    for name, p in data.items():
+        if not Path(p).exists():
+            _dbg.warn(f"Stale wire: '{name}' → '{p}' (file not found)")
+    return dict(data)

wirez_py-1.0.0.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: wirez-py
+Version: 1.0.0
+Summary: Remember and retrieve file paths by name — from any program, anywhere.
+Author: 
+License: MIT
+Project-URL: Homepage, https://github.com/kulbir/wires
+Keywords: files,path,registry,bookmark,wires
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Dynamic: requires-python
+
+# wires
+
+**Remember and retrieve file paths by name — from any program, anywhere.**
+
+```
+pip install wires
+```
+
+---
+
+## Usage
+
+```python
+import wires
+
+# Save / remember a file
+wires.save("my_config", "/path/to/config.json")
+wires.remember("my_config", "/path/to/config.json")  # same thing
+
+# Retrieve it later — from any program
+wires.get("my_config")     # → "/path/to/config.json"  (str)
+wires.recall("my_config")  # same thing
+wires.path("my_config")    # → pathlib.Path
+
+# See all saved files
+wires.list_all()  # → {"my_config": "/path/to/config.json", ...}
+
+# Remove
+wires.remove("my_config")
+```
+
+## How it works
+
+Wires stores all registrations in `~/.wires/registry.json`. Every program on the machine shares this registry, so a path saved in one script is instantly accessible in another.
+
+## License
+
+MIT

wirez_py-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+wires/__init__.py,sha256=8zpWmVtsrs63k3iP4vmAPy4SzwGaJcHJZttg-RtwZRs,2866
+wires/debug.py,sha256=PNoI34NxJcpeO4pPu4lSGa2zxb2iPrKXm1jb2JWj-6g,1015
+wires/registry.py,sha256=7Sc5x4Fn2E5mRkolhfyMQwjaA4iYRtqHpyJaT5yYFKY,2621
+wirez_py-1.0.0.dist-info/METADATA,sha256=tgWPSfa7_M16xb5siMAKY0r8cLZ-3pmIgzR-gOnM6dM,1370
+wirez_py-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+wirez_py-1.0.0.dist-info/top_level.txt,sha256=GF8jMwKatrT-C_vDdmzM89edvYZqwprZaL_LqjL8n_Y,6
+wirez_py-1.0.0.dist-info/RECORD,,

wirez_py-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

wirez_py-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+wires