televault 0.1.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

televault-2.0.0.dist-info/METADATA

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: televault
+Version: 2.0.0
+Summary: Unlimited cloud storage using Telegram MTProto. No local DB - everything on Telegram.
+Project-URL: Homepage, https://github.com/YahyaToubali/televault
+Project-URL: Repository, https://github.com/YahyaToubali/televault
+Author-email: Yahya Toubali <contact@yahyatoubali.me>
+License: MIT
+Keywords: backup,cloud,mtproto,storage,telegram
+Classifier: Development Status :: 3 - Alpha
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Archiving :: Backup
+Requires-Python: >=3.11
+Requires-Dist: aiofiles>=23.2.0
+Requires-Dist: blake3>=0.4.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: cryptography>=42.0.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: telethon>=1.36.0
+Requires-Dist: textual>=0.47.0
+Requires-Dist: zstandard>=0.22.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.2.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# TeleVault
+
+Unlimited cloud storage using your **own** Telegram account. No local database — everything lives in a private Telegram channel, encrypted on your machine before upload.
+
+---
+
+## Install
+
+```bash
+pip install televault
+```
+
+Python 3.11+ is recommended.
+
+---
+
+## Quick Start
+
+```bash
+# 1) Set up your Telegram API credentials (one-time setup)
+export TELEGRAM_API_ID=your_api_id
+export TELEGRAM_API_HASH=your_api_hash
+
+# 2) Login with your Telegram account (MTProto, not bot API)
+televault login
+
+# 3) Set up storage channel (interactive)
+televault setup
+
+# 4) Upload
+TELEVAULT_PASSWORD="strong-password" televault push /path/to/file
+
+# 5) List & download
+televault ls
+TELEVAULT_PASSWORD="strong-password" televault pull <file_id_or_name>
+```
+
+Basic commands:
+
+- `televault login`   – authenticate with Telegram
+- `televault setup`   – set up storage channel (interactive or CLI flags)
+- `televault push`    – upload files / folders (`-r` for recursive)
+- `televault pull`    – download by id or name
+- `televault ls`      – list files with size/chunks/encryption
+- `televault search`  – fuzzy search by name
+- `televault status`  – overall vault stats
+- `televault whoami`  – show current Telegram account
+- `televault logout`  – clear session
+
+All commands check authentication first and will prompt you to run `televault login` if needed.
+
+---
+
+## Interactive TUI
+
+TeleVault includes a rich Terminal User Interface (TUI) for visual file management:
+
+```bash
+# Launch the TUI
+televault tui
+# or
+televault-tui
+```
+
+### TUI Features:
+
+- **📁 File Browser** – Browse all files with details (size, chunks, encryption status)
+- **🔍 Search** – Real-time search through your files
+- **📤 Upload** – Interactive file upload with password protection
+- **📥 Download** – One-click file download
+- **📊 Statistics** – View vault stats (total files, storage used)
+- **⌨️ Keyboard Shortcuts**:
+  - `q` - Quit
+  - `r` - Refresh file list
+  - `u` - Upload file
+  - `d` - Download selected file
+  - `s` - Search files
+  - `l` - Login
+  - `Delete` - Delete selected file
+  - `Enter` - Download selected file
+
+The TUI provides a more visual and interactive way to manage your vault compared to the CLI commands.
+
+---
+
+## Storage Channel Setup
+
+The `televault setup` command provides three ways to configure your storage:
+
+### Interactive Mode (Recommended)
+```bash
+televault setup
+```
+
+You'll be prompted to choose:
+```
+TeleVault Storage Channel Setup
+
+How would you like to set up your storage?
+  1. Create a new private channel (recommended)
+  2. Use an existing channel by ID
+
+Enter your choice (1 or 2):
+```
+
+### Non-Interactive Options
+
+**Auto-create a new channel:**
+```bash
+televault setup --auto-create
+```
+
+**Use an existing channel:**
+```bash
+televault setup --channel-id -1001234567890
+```
+
+> **Note:** Channel IDs should start with `-100` (e.g., `-1001234567890`). Make sure the bot is a member of the channel if using an existing one.
+
+---
+
+## Project Vision
+
+TeleVault is not a SaaS. The goal is to give hackers and power users a **simple, encrypted off‑site backup tool** built on top of infrastructure they already use every day.
+
+- **Turn Telegram into your personal encrypted blob store** instead of spinning up S3 buckets, servers, or dashboards.
+- **Stay client‑side by design** – TeleVault handles chunking, indexing, and crypto; Telegram just stores opaque data.
+- **Be as easy to adopt as `pip install` + `televault login`**, with no extra services to maintain.
+- **Stay portable** – future tooling should make it easy to export / migrate data so you’re never locked into Telegram.
+
+This should feel closer to `restic`/`borg` than a cloud app: a sharp, scriptable tool that respects your threat model.
+
+---
+
+## Features
+
+- **MTProto direct** – Uses Telethon + MTProto (no bot API limits)
+- **Encrypted-by-default** – Client-side AES‑256‑GCM, password-derived keys
+- **Zero local DB** – Metadata index is stored on Telegram itself
+- **Chunked uploads** – Large files split into chunks (up to Telegram's per-file limit)
+- **Resumable transfers** – Can continue interrupted uploads/downloads
+- **Folder support** – Upload directories while preserving structure
+- **Rich CLI** – Progress bars, colored output, and helpful error messages
+- **Interactive TUI** – Full terminal UI with file browser, search, and management
+- **Interactive setup** – Choose between creating new channel or using existing one
+
+---
+
+## Security Model
+
+TeleVault is designed so that Telegram sees only encrypted blobs and JSON metadata; your password never leaves your machine.
+
+- **Encryption**
+  - Files are optionally compressed and then encrypted with **AES‑256‑GCM**.
+  - Keys are derived from your password using **scrypt** (memory‑hard KDF).
+  - Encryption happens **before** data is sent to Telegram.
+
+- **Indexing & Metadata**
+  - Each file has a small JSON metadata message (size, name, chunk ids, hash).
+  - A pinned "index" message in your channel maps file IDs → Telegram message IDs.
+  - No external database or server is required.
+
+- **Sessions & Accounts**
+  - TeleVault authenticates using a standard Telethon session file.
+  - That session lives in your config directory (see below) and is not uploaded.
+
+- **Threat Model (summary)**
+  - If someone gets access to your Telegram account **and** your password, they can read your data.
+  - If they only get Telegram’s servers or just the channel history, they only see encrypted chunks + metadata.
+
+> Important: **Don’t lose your password.** There is no recovery if you forget it and have encryption enabled.
+
+---
+
+## Configuration
+
+Configuration is stored under:
+
+```text
+~/.config/televault/config.json
+```
+
+Example:
+
+```json
+{
+  "channel_id": -1003652003243,
+  "chunk_size": 104857600,
+  "compression": true,
+  "encryption": true,
+  "parallel_uploads": 3,
+  "parallel_downloads": 5,
+  "max_retries": 3,
+  "retry_delay": 1.0
+}
+```
+
+You can override encryption on a per-command basis:
+
+```bash
+# disable encryption for this upload only
+televault push movie.mkv --no-encrypt
+
+# disable compression
+televault push backup.tar --no-compress
+```
+
+The default password can also be set via environment variable:
+
+```bash
+export TELEVAULT_PASSWORD="strong-password"
+televault push secrets.zip
+```
+
+---
+
+## From Source (dev)
+
+```bash
+git clone https://github.com/YahyaToubali/televault.git
+cd televault
+
+# create an isolated env (recommended)
+python -m venv .venv
+source .venv/bin/activate
+
+pip install -e .[dev]
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+---
+
+## Roadmap (early ideas)
+
+This is intentionally small for now; priorities will change as you use it.
+
+- **Snapshots & versioning**
+  - `televault snapshot ~/Projects` with named snapshots and retention rules.
+  - Simple policies like "keep daily snapshots for 7 days, weekly for 4 weeks".
+- **Smarter TUI**
+  - Better file browser, filters (by size/date/encrypted), and batch actions.
+- **Scheduling helpers**
+  - Tiny helper commands or docs for cron/systemd timers ("backup this folder nightly").
+- **Export / migrate tooling**
+  - One‑shot export from Telegram → local disk or other storage (S3, filesystem, etc.).
+- **Multi‑vault support**
+  - Multiple channels as separate vaults (e.g. `personal`, `work`, `archives`).
+
+If you’re reading this on GitHub and want to use TeleVault seriously, open an issue with your use case so priorities can be adjusted.
+
+---
+
+## Requirements
+
+- Telegram account + API credentials from [my.telegram.org](https://my.telegram.org)
+  - Create an app to get your `api_id` and `api_hash`
+  - Set them as environment variables:
+    ```bash
+    export TELEGRAM_API_ID=your_api_id
+    export TELEGRAM_API_HASH=your_api_hash
+    ```
+- Python 3.11 or newer
+
+> **Tip:** Add the export lines to your `~/.bashrc`, `~/.zshrc`, or `~/.profile` to make them persistent.
+
+---
+
+## License
+
+MIT
+
+Author: **Yahya Toubali** · [@yahyatoubali](https://github.com/YahyaToubali)

televault-2.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+televault/__init__.py,sha256=5FWvjEWaQFqBjp918-NB6gwpKzoDl_rUpGfB8w4zRQc,406
+televault/chunker.py,sha256=ykoElL8V7cr9zbqqX8a9QNlVMTRXe5zeuZeqdcYIMZk,5270
+televault/cli.py,sha256=KbnCAcZ7ZgxXagSmdhdYgO-2w2RDSagyjw-EcKgM0cQ,19947
+televault/compress.py,sha256=-exX39XzW3iRKBS24PvB3SlpJbRZMmd_IP9irqeMpV8,4635
+televault/config.py,sha256=718lMMHscVi0b5WHs6NcU8vvHP1RVr5y9xhWyvXMp1c,2055
+televault/core.py,sha256=TIOyswESUEhxsnf24byxVXCsWYcE9eKjrFTsan4yd8c,13741
+televault/crypto.py,sha256=0e2SBje5Zgcwooe8yDC0SzXurOs0qbQUXwepKX51JpQ,5074
+televault/models.py,sha256=vDR7K1OcxWVm3PNbDr6N_E0VYa5V4MvfBEy7a2qqKW4,4586
+televault/telegram.py,sha256=tlUCe84uvN4gENCXM8H7Q34HVNvPhAoYXziSGgq4iOI,12548
+televault/tui.py,sha256=ETiwM2nXzVkdjBRb3rkCzxlfZ7eoKljkJ23Qvf3x__o,20833
+televault-2.0.0.dist-info/METADATA,sha256=Y2EA99uQQr4wGJ3BKJZsOMKUnIlipxk8ujtnVFI7UTA,9287
+televault-2.0.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+televault-2.0.0.dist-info/entry_points.txt,sha256=2zZbEnZlRFqTjjUV9R-Rnng6YMlQzL1JlqYry95R8Qc,111
+televault-2.0.0.dist-info/RECORD,,

{televault-0.1.0.dist-info → televault-2.0.0.dist-info}/entry_points.txt

@@ -1,3 +1,4 @@
 [console_scripts]
 televault = televault.cli:main
+televault-tui = televault.tui:run_tui
 tv = televault.cli:main

televault-0.1.0.dist-info/METADATA

@@ -1,242 +0,0 @@
-Metadata-Version: 2.4
-Name: televault
-Version: 0.1.0
-Summary: Unlimited cloud storage using Telegram MTProto. No local DB - everything on Telegram.
-Project-URL: Homepage, https://github.com/YahyaToubali/televault
-Project-URL: Repository, https://github.com/YahyaToubali/televault
-Author-email: Yahya Toubali <contact@yahyatoubali.me>
-License: MIT
-Keywords: backup,cloud,mtproto,storage,telegram
-Classifier: Development Status :: 3 - Alpha
-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.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: System :: Archiving :: Backup
-Requires-Python: >=3.11
-Requires-Dist: aiofiles>=23.2.0
-Requires-Dist: blake3>=0.4.0
-Requires-Dist: click>=8.1.0
-Requires-Dist: cryptography>=42.0.0
-Requires-Dist: rich>=13.7.0
-Requires-Dist: telethon>=1.36.0
-Requires-Dist: textual>=0.47.0
-Requires-Dist: zstandard>=0.22.0
-Provides-Extra: dev
-Requires-Dist: mypy>=1.8.0; extra == 'dev'
-Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
-Requires-Dist: pytest>=8.0.0; extra == 'dev'
-Requires-Dist: ruff>=0.2.0; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# TeleVault
-
-Unlimited cloud storage using Telegram MTProto. No local database — everything lives on Telegram.
-
-## Features
-
-- **MTProto Direct** — No bot API limits, 2GB file support
-- **Zero Local DB** — Metadata stored on Telegram itself
-- **Client-Side Encryption** — AES-256-GCM before upload
-- **Smart Chunking** — Large files split automatically
-- **Parallel Processing** — Faster uploads/downloads
-- **Folder Support** — Preserve directory structure
-- **Resume Capability** - Continue interrupted transfers
-- **TUI + CLI** - Beautiful terminal interface
-
-## Install
-
-```bash
-pip install televault
-```
-
-Or from source:
-
-```bash
-git clone https://github.com/YahyaToubali/televault
-cd televault
-pip install -e .".
-```
-
-## Quick Start
-
-```bash
-# First time: authenticate with Telegram
-televault login
-
-# Upload a file
-televault push backup.tar.gz
-
-# Upload a directory
-televault push ~/Documents/ -r --no-encrypt
-
-# List files
-televault ls
-
-# Download
-televault pull backup.tar.gz
-
-# Interactive TUI
-televault
-```
-
-## How It Works
-
-```
-Your File
-    ↓
-[Compress] → zstd (optional, skips media)
-    ↓
-[Encrypt] → AES-256-GCM with Scrypt key derivation
-    ↓
-[Chunk] → Split into ≤2GB pieces
-    ↓
-[Upload] → MTProto to your private channel
-    ↓
-[Index] → Metadata stored as pinned message
-```
-
-### Channel Structure
-
-```
-📌 INDEX (pinned)
-│   └── {"files": {"id1": msg_id, "id2": msg_id, ...}}
-│
-├── 📄 Metadata Message (JSON)
-│   └── {"name": "file.zip", "size": 5GB, "chunks": [...]}
-│
-└── 📦 Chunk Messages (reply to metadata)
-    └── file_id_001.chunk, file_id_002.chunk, ...
-```
-
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `televault login` | Authenticate with Telegram |
-| `televault logout` | Clear session |
-| `televault push <file>` | Upload file (or directory with -r) |
-| `televault pull <file>` | Download file |
-| `televault ls` | List all files |
-| `televault search <query>` | Search files by name |
-| `televault rm <file>` | Delete file |
-| `televault info <file>` | Show file details |
-| `televault status` | Show vault status |
-| `televault whoami` | Show current Telegram account |
-| `televault` | Launch TUI |
-
-## Configuration
-
-Config stored at `~/.config/televault/config.json`:
-
-```json
-{
-  "channel_id": -1003652003243,
-  "chunk_size": 104857600,
-  "compression": true,
-  "encryption": true,
-  "parallel_uploads": 3,
-  "parallel_downloads": 5,
-  "max_retries": 3,
-  "retry_delay": 1.0
-}
-```
-
-## Security
-
-- **Encryption**: AES-256-GCM (authenticated encryption)
-- **Key Derivation**: Scrypt (memory-hard, GPU-resistant)
-- **Session**: Telegram MTProto session stored encrypted
-- **Zero Knowledge**: Server never sees unencrypted data
-- **MTProto**: Direct Telegram protocol (no bot API limits)
-
-## Prerequisites
-
-- Telegram API credentials (get at [my.telegram.org](https://my.telegram.org))
-- Telegram account
-- Python 3.11+
-
-## Installation
-
-### From PyPI
-
-```bash
-pip install televault
-```
-
-### From Source
-
-```bash
-git clone https://github.com/YahyaToubali/televault
-cd televault
-pip install -e .".
-```
-
-## Setup
-
-```bash
-# Authenticate with Telegram
-televault login
-
-# Set up storage channel
-televault setup
-
-# Upload your first file
-televault push hello.txt
-```
-
-## Usage Examples
-
-### Upload a file
-```bash
-televault push backup.tar.gz --password mysecret
-```
-
-### Upload a directory
-```bash
-televault push ~/Documents/ -r --no-encrypt
-```
-
-### Download a file
-```bash
-televault pull backup.tar.gz --password mysecret
-```
-
-### List files
-```bash
-televault ls --sort=size
-```
-
-### Search files
-```bash
-televault search "*.sql"
-```
-
-## TUI
-
-Launch the interactive terminal interface:
-
-```bash
-televault
-```
-
-Controls:
-- `r` = Refresh
-- `u` = Upload
-- `d` = Download selected
-- `q` = Quit
-- Arrow keys to navigate
-
-## License
-
-MIT
-
-## Author
-
-Yahya Toubali - [@yahyatoubali](https://github.com/YahyaToubali)
-
----
-
-Built with ❤️ using Python, Telethon, and Textual

televault-0.1.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-televault/__init__.py,sha256=rMVzSux5x0gb1u6Vede5MgTgNu-nBOgOtIat5Q_gGRU,405
-televault/chunker.py,sha256=Hqh8dptBRlO8DdwEOgS0mXF0NJhZMYG9alF6oCrHkg4,5387
-televault/cli.py,sha256=jBldMotU27yiP21GlkGxUUXjib8JbL0ixPS3rsU3-Vw,15815
-televault/compress.py,sha256=WNuR7in1sWIK7vtJ3fciJr7YLQlymcRd_hySzl_28aI,4578
-televault/config.py,sha256=-w-VQ7tyJ1LB6RHjmgvllnaWh4anORE1ukSRA9gVIv4,2157
-televault/core.py,sha256=siDoxvN8ftnXhmbLGpO3J94pBhtXSqUiCD8dDddWCQ8,16723
-televault/crypto.py,sha256=cYygPj4X_Tq3jTSDJM1KzVyL69KW8r18pUvyq7JInL0,5267
-televault/models.py,sha256=NduoXIyY-n7nqQ4VLorxC9IuoNVPWZhoDuccJM_epxE,4717
-televault/telegram.py,sha256=ShAGx8xBK2tcGGl9-eXuerYlgPfE8JFSecGJLQHoVLk,12023
-televault-0.1.0.dist-info/METADATA,sha256=Djst_CPh0rbCzkUASu3D47SbKT0uFignCLATaIZA1D8,5299
-televault-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-televault-0.1.0.dist-info/entry_points.txt,sha256=9bmq5Yu2HkyF9XVs-O4ydox-Skug2xI-aWeN9o52k8I,73
-televault-0.1.0.dist-info/RECORD,,