|
1 | | -# torrra |
2 | | -CLI-based torrent search and downloader |
| 1 | +# torrra 🎯 |
| 2 | + |
| 3 | +> CLI-based torrent search and downloader |
| 4 | +
|
| 5 | +`torrra` is a sleek and minimal command-line tool to search torrents from various indexers and download them- all from your terminal. |
| 6 | + |
| 7 | +## ✨ Features |
| 8 | + |
| 9 | +- Search torrents from multiple indexers (`YTS` supported; more coming) |
| 10 | +- Fetch magnet links directly |
| 11 | +- Download torrents via libtorrent |
| 12 | +- Pretty CLI with Rich-powered progress bars |
| 13 | +- Modular and easily extensible indexer architecture |
| 14 | + |
| 15 | +## 📦 Installation |
| 16 | + |
| 17 | +> Requires Python 3.11+ and [libtorrent-rasterbar](https://libtorrent.org/). |
| 18 | +
|
| 19 | +### 1. Install `libtorrent` |
| 20 | + |
| 21 | +```bash |
| 22 | +# Linux (Arch) |
| 23 | +sudo pacman -S libtorrent-rasterbar |
| 24 | +# Linux (Debian/Ubuntu) |
| 25 | +sudo apt install python3-libtorrent |
| 26 | + |
| 27 | +# macOS (Homebrew) |
| 28 | +brew install libtorrent-rasterbar |
| 29 | + |
| 30 | +# Windows/macOS (Python wheels) |
| 31 | +pip install python-libtorrent |
| 32 | +``` |
| 33 | + |
| 34 | +> Note: For Windows users, the `python-libtorrent` wheel includes all dependencies and is the recommended method. |
| 35 | +
|
| 36 | +### 2. Install `torrra` |
| 37 | +```bash |
| 38 | +pip install torrra |
| 39 | +``` |
| 40 | + |
| 41 | +### OR: compile from source (advanced) |
| 42 | + |
| 43 | +See libtorrent's build guide: |
| 44 | +https://libtorrent.org/building.html |
| 45 | + |
| 46 | +For local development, fork the repo, then: |
| 47 | + |
| 48 | +```bash |
| 49 | +git clone https://github.com/yourusername/torrra |
| 50 | +cd torrra |
| 51 | +uv sync |
| 52 | +``` |
| 53 | + |
| 54 | +## 💡 Usage |
| 55 | + |
| 56 | +```bash |
| 57 | +torrra |
| 58 | +``` |
| 59 | + |
| 60 | +Follow the prompts: |
| 61 | + |
| 62 | +1. Enter search query |
| 63 | +2. Pick an indexer |
| 64 | +3. Select a torrent |
| 65 | +4. Choose quality / magnet link |
| 66 | +5. Pick a download folder |
| 67 | + |
| 68 | +## 🧩 Indexer Support |
| 69 | + |
| 70 | +Currently supported: |
| 71 | + |
| 72 | +- YTS (movies) |
| 73 | + |
| 74 | +Planned: |
| 75 | + |
| 76 | +- 1337x |
| 77 | +- GLodls |
| 78 | +- Nyaa (anime-only, optional) |
| 79 | +- Community-driven additions |
| 80 | + |
| 81 | +## 🛠️ Dev Notes |
| 82 | + |
| 83 | +- Modular indexer structure (`torrra/indexers`) |
| 84 | +- Extend `BaseIndexer` to add new sources |
| 85 | +- Built using: |
| 86 | + - `httpx` + `selectolax` for scraping |
| 87 | + - `libtorrent` for torrenting |
| 88 | + - `rich` for CLI visuals |
| 89 | + - `questionary` for input prompts |
| 90 | + |
| 91 | +## 📜 License |
| 92 | + |
| 93 | +MIT © [stabldev](https://github.com/stabldev) |
0 commit comments