qbittorrent/search-plugins
Search Plugins
This is a collection of search plugins and a Python-based framework for extending qBittorrent's built-in search capabilities. The project provides a plugin-class-based search engine architecture where each torrent site is wrapped in a Python class that implements a standard search interface, allowing the client to query multiple sources uniformly. It includes a Torznab API standard integration for connecting to standardized search engines, and supports external proxy aggregation through Jackett to route queries through a server that aggregates results from many private and public trackers.
The framework enables writing custom search plugins that scrape torrent websites and return formatted results, with helper functions for consistent output formatting and HTML/XML parsing via the Python standard library. Plugins can be tested locally using the nova2.py script before installation, and the client supports concurrent request throttling to balance search speed against server load. The project includes a plugin installation manager for adding, enabling, disabling, and removing search plugins through the client interface, with file-based installation by placing Python files in a designated configuration directory.
The collection covers Torznab search engine support for standardized API-based torrent queries, and the Jackett proxy integration allows configuring an external proxy server with API key and address settings to aggregate multiple indexers. The framework supports community-driven requests for new plugins targeting specific torrent sites, and provides documentation for plugin authoring including URL fetching, web page parsing, result formatting, and torrent file downloading.
Features
- qBittorrent Search Plugins - Creating custom Python search plugins that scrape torrent websites and return formatted results for qBittorrent's built-in search engine.
- Search Plugin Collections - Plugins that extend qBittorrent's built-in search to query additional torrent websites and indexers.
- Standard Library Parsing - Plugins extract torrent details from web pages using built-in Python modules like HTMLParser or regex, avoiding external dependencies for parsing.
- Torrent Result Formatters - Outputs each torrent as a single line with fields like link, name, size, seeds, and leechers separated by a middle dot.
- Plugin-Class Search Engines - Each torrent site is wrapped in a Python class that implements a standard search interface, allowing the client to query multiple sources uniformly.
- Torznab - Adds a Torznab-compatible search engine as a plugin to enable standardized API-based torrent searches.
- Torznab Integrations - Plugin that adds Torznab-compatible search engines to qBittorrent for standardized API-based torrent queries.
- Shared Formatting Helpers - Passes a dictionary of torrent fields to the prettyPrinter function, which formats and prints the output correctly.
- Torrent Search Aggregators - Running searches across multiple torrent websites simultaneously from within the qBittorrent interface using installed plugins.
- Plugin Frameworks - A Python-based system for writing, testing, and installing search plugins that scrape torrent sites and return formatted results.
- Search Result Extraction - Uses built-in Python modules like HTMLParser or regex to extract torrent details from a search engine's HTML or XML.
- Jackett - Configuring a Jackett server as an external proxy to aggregate search results from many private and public torrent trackers through a single plugin.
- Search Proxy Aggregators - The Jackett plugin routes queries through an external proxy server that aggregates results from many private and public trackers, reducing per-site plugin maintenance.
- Torznab API Connectors - Plugins can use the Torznab API format to connect to standardized search engines, enabling compatibility with a wide range of indexers without custom parsing.
- Plugin Testing Scripts - Runs the plugin via the nova2.py script from the command line to verify search results before installing in qBittorrent.
- Plugin Requests - Creates new search plugins using a documented format to extend the application's search capabilities to additional websites.
- Plugin Installation and Management - Interface for adding, disabling, and removing search plugins from qBittorrent's search engine configuration.
- Python Plugin Directory Installations - New search plugins are added by placing Python files in a designated configuration directory, making installation a simple file-copy operation.
- Concurrent Request Limits - The client limits simultaneous queries to a configurable maximum, balancing search speed against server load and preventing rate limiting.
- Torrent Clients - Extends client functionality with custom search providers for public trackers.
