lantern-p2p 1.0.0__tar.gz

lantern_p2p-1.0.0/.gitignore

@@ -0,0 +1,33 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+venv/
+env/
+ENV/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Shared files (user data)
+shared_files/
+!shared_files/.gitkeep
+
+# Logs
+*.log
+
+extras/
+
+# Build artifacts
+dist/
+build/
+*.egg-info/

lantern_p2p-1.0.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: lantern-p2p
+Version: 1.0.0
+Summary: Lantern - A P2P file sharing system with TUI dashboard
+Project-URL: Homepage, https://github.com/shx-dow/lantern
+Project-URL: Documentation, https://github.com/shx-dow/lantern#readme
+Project-URL: Repository, https://github.com/shx-dow/lantern
+Project-URL: Issues, https://github.com/shx-dow/lantern/issues
+Author-email: shx-dow <83426772+shx-dow@users.noreply.github.com>
+License: MIT
+Keywords: file-sharing,lan,p2p,transfer,tui
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: File Sharing
+Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: textual>=0.50.0
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Lantern
+
+A peer-to-peer file sharing system with a beautiful terminal UI (TUI) dashboard.
+
+![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+## Features
+
+- **P2P File Sharing** - Share files directly between computers on the same network
+- **Auto Discovery** - Automatically discovers peers on the LAN via UDP broadcast
+- **Beautiful TUI** - Modern terminal interface built with Textual
+- **Dual Mode** - Both CLI and TUI modes available
+- **Light/Dark Themes** - Toggle between color schemes
+- **Progress Bars** - Visual feedback for large file transfers
+- **Notifications** - Toast notifications for operation completion
+- **Path Safety** - Built-in protection against path traversal attacks
+
+## Installation
+
+### From PyPI (when published)
+
+```bash
+pip install lantern-p2p
+```
+
+### From Source
+
+```bash
+git clone https://github.com/shx-dow/lantern.git
+cd lantern
+pip install -e .
+```
+
+## Usage
+
+### TUI Mode (Default)
+
+Launch the terminal dashboard (beautiful visual interface):
+
+```bash
+lantern
+```
+
+Or explicitly:
+
+```bash
+lantern --tui
+```
+
+### CLI Mode
+
+Use command-line interface (text-based commands):
+
+```bash
+lantern --cli
+```
+
+Available CLI commands:
+- `peers` - Show discovered peers
+- `list <host[:port]>` - List files on remote peer
+- `download <host[:port]> <file>` - Download a file
+- `upload <host[:port]> <path>` - Upload a file
+- `delete <host[:port]> <file>` - Delete remote file
+- `myfiles` - List your shared files
+- `help` - Show help
+- `quit` - Exit
+
+### Custom Port
+
+```bash
+lantern --port 6000
+```
+
+## Key Bindings (TUI Mode)
+
+| Key | Action |
+|-----|--------|
+| `F1` | Show help |
+| `F5` | Refresh files |
+| `t` | Toggle theme |
+| `u` | Upload file |
+| `d` | Download file |
+| `x` | Delete file |
+| `Tab` | Cycle focus |
+| `q` | Quit |
+
+## Configuration
+
+Shared files are stored in the `shared_files/` directory by default. This directory is created automatically when you first run Lantern.
+
+## Requirements
+
+- Python 3.8 or higher
+- textual >= 0.50.0
+- psutil >= 5.9.0
+
+## Architecture
+
+```
+lantern/
+├── config.py      # Configuration constants
+├── protocol.py    # Message framing & file transfer protocol
+├── discovery.py   # UDP peer discovery
+├── server.py      # TCP file server
+├── client.py      # TCP client operations
+├── peer.py        # CLI entry point
+├── tui.py         # Textual TUI dashboard
+├── main.py        # Package entry point
+└── styles/        # CSS stylesheets
+    └── lantern.css
+```
+
+## Development
+
+Install with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run linting:
+
+```bash
+black lantern/
+ruff check lantern/
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions welcome! Please open an issue or pull request.
+
+## Acknowledgments
+
+Built with [Textual](https://textual.textualize.io/) for the TUI.

lantern_p2p-1.0.0/README.md

@@ -0,0 +1,139 @@
+# Lantern
+
+A peer-to-peer file sharing system with a beautiful terminal UI (TUI) dashboard.
+
+![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+## Features
+
+- **P2P File Sharing** - Share files directly between computers on the same network
+- **Auto Discovery** - Automatically discovers peers on the LAN via UDP broadcast
+- **Beautiful TUI** - Modern terminal interface built with Textual
+- **Dual Mode** - Both CLI and TUI modes available
+- **Light/Dark Themes** - Toggle between color schemes
+- **Progress Bars** - Visual feedback for large file transfers
+- **Notifications** - Toast notifications for operation completion
+- **Path Safety** - Built-in protection against path traversal attacks
+
+## Installation
+
+### From PyPI (when published)
+
+```bash
+pip install lantern-p2p
+```
+
+### From Source
+
+```bash
+git clone https://github.com/shx-dow/lantern.git
+cd lantern
+pip install -e .
+```
+
+## Usage
+
+### TUI Mode (Default)
+
+Launch the terminal dashboard (beautiful visual interface):
+
+```bash
+lantern
+```
+
+Or explicitly:
+
+```bash
+lantern --tui
+```
+
+### CLI Mode
+
+Use command-line interface (text-based commands):
+
+```bash
+lantern --cli
+```
+
+Available CLI commands:
+- `peers` - Show discovered peers
+- `list <host[:port]>` - List files on remote peer
+- `download <host[:port]> <file>` - Download a file
+- `upload <host[:port]> <path>` - Upload a file
+- `delete <host[:port]> <file>` - Delete remote file
+- `myfiles` - List your shared files
+- `help` - Show help
+- `quit` - Exit
+
+### Custom Port
+
+```bash
+lantern --port 6000
+```
+
+## Key Bindings (TUI Mode)
+
+| Key | Action |
+|-----|--------|
+| `F1` | Show help |
+| `F5` | Refresh files |
+| `t` | Toggle theme |
+| `u` | Upload file |
+| `d` | Download file |
+| `x` | Delete file |
+| `Tab` | Cycle focus |
+| `q` | Quit |
+
+## Configuration
+
+Shared files are stored in the `shared_files/` directory by default. This directory is created automatically when you first run Lantern.
+
+## Requirements
+
+- Python 3.8 or higher
+- textual >= 0.50.0
+- psutil >= 5.9.0
+
+## Architecture
+
+```
+lantern/
+├── config.py      # Configuration constants
+├── protocol.py    # Message framing & file transfer protocol
+├── discovery.py   # UDP peer discovery
+├── server.py      # TCP file server
+├── client.py      # TCP client operations
+├── peer.py        # CLI entry point
+├── tui.py         # Textual TUI dashboard
+├── main.py        # Package entry point
+└── styles/        # CSS stylesheets
+    └── lantern.css
+```
+
+## Development
+
+Install with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run linting:
+
+```bash
+black lantern/
+ruff check lantern/
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions welcome! Please open an issue or pull request.
+
+## Acknowledgments
+
+Built with [Textual](https://textual.textualize.io/) for the TUI.

lantern_p2p-1.0.0/lantern/__init__.py

@@ -0,0 +1,51 @@
+"""
+Lantern - P2P File Sharing System
+
+A peer-to-peer file sharing application with a beautiful TUI dashboard.
+"""
+
+__version__ = "1.0.0"
+__author__ = "shx-dow"
+
+from .config import (
+    TCP_PORT,
+    UDP_PORT,
+    BUFFER_SIZE,
+    BROADCAST_INTERVAL,
+    PEER_TIMEOUT,
+    SEPARATOR,
+    SHARED_DIR,
+    PEER_ID,
+)
+from .discovery import PeerDiscovery
+from .server import FileServer
+from .client import (
+    fetch_file_list,
+    do_download,
+    do_upload,
+    do_delete,
+    format_size,
+)
+from .protocol import send_msg, recv_msg, send_file, recv_file
+
+__all__ = [
+    "TCP_PORT",
+    "UDP_PORT",
+    "BUFFER_SIZE",
+    "BROADCAST_INTERVAL",
+    "PEER_TIMEOUT",
+    "SEPARATOR",
+    "SHARED_DIR",
+    "PEER_ID",
+    "PeerDiscovery",
+    "FileServer",
+    "fetch_file_list",
+    "do_download",
+    "do_upload",
+    "do_delete",
+    "format_size",
+    "send_msg",
+    "recv_msg",
+    "send_file",
+    "recv_file",
+]

lantern_p2p-1.0.0/lantern/client.py

@@ -0,0 +1,212 @@
+"""
+TCP client — connects to a remote peer and performs file operations.
+
+Each operation opens a fresh TCP connection, sends a command, processes the
+response, and closes the connection.  This keeps the protocol stateless and
+simple.
+
+Two API layers:
+  - Core functions (fetch_*) return structured data for the TUI.
+  - CLI wrappers (list_files, download_file, …) print results for the CLI.
+"""
+
+import os
+import socket
+
+from .config import SEPARATOR, BUFFER_SIZE, SHARED_DIR
+from .protocol import send_msg, recv_msg, recv_file
+
+
+def _connect(host: str, port: int) -> socket.socket:
+    """Open a TCP connection to a remote peer."""
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    sock.settimeout(10)
+    sock.connect((host, port))
+    return sock
+
+
+def format_size(size_bytes: int | float) -> str:
+    """Human-readable file size."""
+    for unit in ("B", "KB", "MB", "GB"):
+        if size_bytes < 1024:
+            return f"{size_bytes:.1f} {unit}"
+        size_bytes /= 1024
+    return f"{size_bytes:.1f} TB"
+
+
+# ======================================================================
+# Core API — returns structured data (used by TUI and CLI wrappers)
+# ======================================================================
+
+def fetch_file_list(host: str, port: int) -> list[dict]:
+    """
+    Fetch the file listing from a remote peer.
+
+    Returns a list of dicts: [{"name": str, "size": int}, ...]
+    Raises RuntimeError on protocol errors.
+    """
+    sock = _connect(host, port)
+    try:
+        send_msg(sock, "LIST")
+        response = recv_msg(sock)
+        if response is None:
+            raise RuntimeError("No response from peer")
+
+        parts = response.split(SEPARATOR, 1)
+        if parts[0] != "OK":
+            raise RuntimeError(parts[1] if len(parts) > 1 else "Unknown error")
+
+        listing = parts[1] if len(parts) > 1 else ""
+        if not listing.strip():
+            return []
+
+        files = []
+        for line in listing.split("\n"):
+            if SEPARATOR in line:
+                name, size_str = line.split(SEPARATOR, 1)
+                files.append({"name": name, "size": int(size_str)})
+        return files
+    finally:
+        sock.close()
+
+
+def do_download(host: str, port: int, filename: str) -> tuple[str, int]:
+    """
+    Download a file from a remote peer.
+
+    Returns (destination_path, bytes_received).
+    Raises RuntimeError on failure.
+    """
+    sock = _connect(host, port)
+    try:
+        send_msg(sock, f"DOWNLOAD{SEPARATOR}{filename}")
+        response = recv_msg(sock)
+        if response is None:
+            raise RuntimeError("No response from peer")
+
+        if response.startswith("ERROR"):
+            parts = response.split(SEPARATOR, 1)
+            raise RuntimeError(parts[1] if len(parts) > 1 else "Unknown error")
+
+        os.makedirs(SHARED_DIR, exist_ok=True)
+        dest = os.path.join(SHARED_DIR, filename)
+        received = recv_file(sock, dest)
+        return dest, received
+    finally:
+        sock.close()
+
+
+def do_upload(host: str, port: int, filepath: str) -> str:
+    """
+    Upload a local file to a remote peer.
+
+    Returns a success message string.
+    Raises RuntimeError on failure.
+    """
+    if not os.path.isfile(filepath):
+        raise RuntimeError(f"Local file not found: {filepath}")
+
+    filename = os.path.basename(filepath)
+    filesize = os.path.getsize(filepath)
+
+    sock = _connect(host, port)
+    try:
+        send_msg(sock, f"UPLOAD{SEPARATOR}{filename}{SEPARATOR}{filesize}")
+
+        response = recv_msg(sock)
+        if response is None or not response.startswith("OK"):
+            parts = (response or "").split(SEPARATOR, 1)
+            raise RuntimeError(f"Peer rejected upload: {parts[1] if len(parts) > 1 else 'unknown'}")
+
+        sent = 0
+        with open(filepath, "rb") as f:
+            while sent < filesize:
+                chunk = f.read(BUFFER_SIZE)
+                if not chunk:
+                    break
+                sock.sendall(chunk)
+                sent += len(chunk)
+
+        confirm = recv_msg(sock)
+        if confirm and confirm.startswith("OK"):
+            parts = confirm.split(SEPARATOR, 1)
+            return parts[1] if len(parts) > 1 else "Upload complete"
+        else:
+            parts = (confirm or "").split(SEPARATOR, 1)
+            raise RuntimeError(f"Upload issue: {parts[1] if len(parts) > 1 else 'unknown'}")
+    finally:
+        sock.close()
+
+
+def do_delete(host: str, port: int, filename: str) -> str:
+    """
+    Request deletion of a file on a remote peer.
+
+    Returns a success message string.
+    Raises RuntimeError on failure.
+    """
+    sock = _connect(host, port)
+    try:
+        send_msg(sock, f"DELETE{SEPARATOR}{filename}")
+        response = recv_msg(sock)
+        if response is None:
+            raise RuntimeError("No response from peer")
+
+        parts = response.split(SEPARATOR, 1)
+        msg = parts[1] if len(parts) > 1 else ""
+
+        if parts[0] == "OK":
+            return msg
+        else:
+            raise RuntimeError(msg)
+    finally:
+        sock.close()
+
+
+# ======================================================================
+# CLI wrappers — print results (used by peer.py CLI mode)
+# ======================================================================
+
+def list_files(host: str, port: int) -> None:
+    """Print the file listing from a remote peer."""
+    try:
+        files = fetch_file_list(host, port)
+    except RuntimeError as e:
+        print(f"  [!] {e}")
+        return
+
+    if not files:
+        print("  (no files)")
+        return
+
+    print(f"  {'Filename':<40} {'Size':>12}")
+    print(f"  {'-'*40} {'-'*12}")
+    for f in files:
+        print(f"  {f['name']:<40} {format_size(f['size']):>12}")
+
+
+def download_file(host: str, port: int, filename: str) -> None:
+    """Download a file and print the result."""
+    try:
+        dest, received = do_download(host, port, filename)
+        print(f"  Downloaded {filename} ({format_size(received)}) -> {dest}")
+    except RuntimeError as e:
+        print(f"  [!] {e}")
+
+
+def upload_file(host: str, port: int, filepath: str) -> None:
+    """Upload a file and print the result."""
+    try:
+        msg = do_upload(host, port, filepath)
+        print(f"  {msg}")
+    except RuntimeError as e:
+        print(f"  [!] {e}")
+
+
+def delete_file(host: str, port: int, filename: str) -> None:
+    """Delete a remote file and print the result."""
+    try:
+        msg = do_delete(host, port, filename)
+        print(f"  {msg}")
+    except RuntimeError as e:
+        print(f"  [!] {e}")

lantern_p2p-1.0.0/lantern/config.py

@@ -0,0 +1,23 @@
+"""
+Configuration constants for the P2P file sharing system.
+"""
+
+import os
+import uuid
+
+# --- Networking ---
+TCP_PORT = 5000              # Default TCP port for file operations
+UDP_PORT = 5001              # UDP port for peer discovery broadcasts
+BUFFER_SIZE = 4096           # Chunk size (bytes) for file transfer
+BROADCAST_INTERVAL = 5       # Seconds between UDP discovery beacons
+PEER_TIMEOUT = 15            # Seconds before a peer is considered offline
+
+# --- Protocol ---
+SEPARATOR = "<SEP>"          # Delimiter used in protocol messages
+
+# --- File Storage ---
+SHARED_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "shared_files")
+
+# --- Identity ---
+# Each peer gets a unique ID at startup so it can ignore its own broadcasts
+PEER_ID = str(uuid.uuid4())[:8]