lantern-p2p 1.0.1

Lantern - A P2P file sharing system with TUI dashboard

Lantern

A peer-to-peer file sharing system with a beautiful terminal UI (TUI) dashboard.

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)

pip install lantern-p2p

From Source

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):

lantern

Or explicitly:

lantern --tui

CLI Mode

Use command-line interface (text-based commands):

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

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:

pip install -e ".[dev]"

Run linting:

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 for the TUI.