Skip to main content

Dynamic menu interface for TPB, built with rofi in mind.

Project description

rofi-tpb

Dynamic menu interface for The Pirate Bay, built with rofi in mind.

Install

pip install rofi-tpb

Consider using pipx:

pipx install rofi-tpb

Usage

Prompt to either search tpb or browse tpb's top torrents:

rofi-tpb

Prompt for search query:

rofi-tpb search

Search for ubuntu related torrents:

rofi-tpb search ubuntu

Browse tpb's top torrents across all categories:

rofi-tpb top all

Browse tpb's recent top torrents across all categories in the last 48h:

rofi-tpb top all -r

Check the help for details:

rofi-tpb --help
...
rofi-tpb search --help
...
rofi-tpb top --help
...

Dependencies

  • python >= 3.6
  • tpblite
  • dynmen
  • lxml
  • traitlets (undeclared dependency of dynmen)

Configuration

rofi-tpb stores its config in $XDG_CONFIG_HOME/rofi-tpb/config.ini.

The default configuration is the following:

[menu]
command = rofi -dmenu -i
torrent_format = {title:<65} 📁{filesize:<12} 🔽{seeds:<4} 🔼{leeches:<4} Trusted: {trusted} VIP: {vip}
vip_str = 
not_vip_str = 
trusted_str = 
not_trusted_str = 
use_tpb_proxy = True
tpb_url = https://thepiratebay0.org
categories = All, APPLICATIONS, AUDIO, GAMES, OTHER, PORN, VIDEO
categories_48h = True

[actions]
add = xdg-open '{magnetlink}'
open = xdg-open '{url}'
  • menu.command: the dynamic menu command which should read from stdin and output to stdout, if you want to use dmenu instead of rofi then adjust this command accordingly.
  • menu.torrent_format: text representation of a torrent in the dynamic menu, accepts torrent string format keys.
  • menu.use_tpb_proxy: if True will use the first tpb url as found on https://piratebayproxy.info/.
  • menu.vip_str: string to use in the menu.torrent_format when the user is VIP.
  • menu.not_vip_str: string to use in the menu.torrent_format when the user is not VIP.
  • menu.trusted_str: string to use in the menu.torrent_format when the user is trusted.
  • menu.not_trusted_str: string to use in the menu.torrent_format when the user is not trusted.
  • menu.tpb_url: tpb url, if use_tpb_proxy is True acts as a fallback url in case https://piratebayproxy.info/ is unavailable or the parsing fails.
  • menu.categories: comma separated list of tpb categories, when browsing the top torrents.
  • menu.categories_48h: add last 48h top torrent categories.
  • actions.*: commands to run on the selected torrent, accepts torrent string format keys.

Available torrent string format keys:

  • {title}: torrent title
  • {filesize}: torrent file size
  • {seeds}: number of seeders
  • {leeches}: number of leechers
  • {uploader}: torrent uploader
  • {upload_date}: upload date
  • {url}: torrent's tpb url
  • {magnetlink}: torrent magnet link
  • {vip}: uploader is VIP, replaced with menu.vip_str/menu.not_vip_str.
  • {trusted}: uploader is trusted, replaced with menu.trusted_str/menu.not_trusted_str.

If the menu.command uses rofi, rofi-tpb will use rofi's -multiple-select flag to allow for selecting multiple torrents.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rofi-tpb-0.2.7.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

rofi_tpb-0.2.7-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file rofi-tpb-0.2.7.tar.gz.

File metadata

  • Download URL: rofi-tpb-0.2.7.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.12.15-arch1-1

File hashes

Hashes for rofi-tpb-0.2.7.tar.gz
Algorithm Hash digest
SHA256 606d10ec71562c97222141dbc0467aaaa9737cf5bf78136d33f07a2b0d3c35ef
MD5 4b6c7f80785c191f1068e63dd63875eb
BLAKE2b-256 170e5476db7d35de52c4788a0c4e42136763db3f24013e276d6c293f7b09ccc5

See more details on using hashes here.

File details

Details for the file rofi_tpb-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: rofi_tpb-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.12.15-arch1-1

File hashes

Hashes for rofi_tpb-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a24b8b0c998968c3bc7100200ad6a3e40c54e9b7db36d2964a8b254ab3d73b73
MD5 726359fdecd9a6c353ca189c23fd67ce
BLAKE2b-256 ace205af9a94351cf860b4cd748f7e4907f2174d4f0ba90d40c7e7a94e1f7e5a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page