Skip to main content

Raincoat-prowlarr is a tool to search torrents using jackett and search torrents and nzb files using prowlarr and send them to your client.

Project description

Raincoat

Raincoat_prowlarr is a CLI tool to search torrents using Jackett's indexers or Prowlarr and send them directly to your client. Prowlarr supports NZB indexer.

Installation

`pip install raincoat-prowlarr

Requirements

  • Python 3.6+
  • Jackett and configured indexers
  • Or Prowlarr and configure indexers
  • qBittorrent, Transmission or Deluge (or use local download option)
  • nzbget, downloader for nzb files
  • libtorrent if you use local downloader and magnet links.
    • Arch: pacman -S libtorrent-rasterbar
    • Ubuntu: apt-get install python-libtorrent -y
    • Fedora: dnf install rb_libtorrent-python2

Usage

raincoat_prowlarr "Terms to search"

Parameters

  • --indexer_manager
    • specify the indexer manager to search; prowlarr or jackett
  • --jackett_ key
    • Specify a Jackett API key
  • --prowlarr_ key
    • Specify a Prowlarr API key
  • -l, --length
    • Max number of characters displayed in the "Description" column.
  • -L, --limit
    • Limits the number of results displayed.
  • -c, --config
    • Specifies a different config path.
  • -s, --sort
    • Change the sorting criteria. Valid choices are: 'seeders', 'leechers', 'ratio', 'size' and 'description'. Default/not specified is 'seeders'.
  • --jackett_indexer
    • Change the indexer for Jackett used for your search, in cases where you want to only search one site. Default is "all".
  • --prowlarr_indexer
    • Change the indexer for prowlarr used for your search, in cases where you want to only search one site. Default is "". "" for all; -1 for all usenet; -2 for all torrents. look at https://wiki.servarr.com/prowlarr/search
  • -d, --download x
    • Grab the first x resultd and send to the client immediately. Defaults to 1.
  • -K, --insecure
    • Don't verify certificates
  • --local
    • Force use of "local" file download.
  • --list
    • Specify a file to load search terms from. One term per line.
  • --verbose
    • Extra verbose logging sent to log file.

Configuration file

Upon installation, a config file is created in your home directory. Before you can use Raincoat, you will need to modify it.

{
    "indexer_manager": "prowlarr",
	"jackett_apikey": "",
	"jackett_url": "http://your_base_jackett_url:port",
	"jackett_indexer": "all",
	"prowlarr_apikey": "",
    "prowlarr_url": "http://you_base_prowlarr_url:port",
    "prowlarr_indexer": "",
	"description_length": 100,
	"exclude": "words to exclude",
	"results_limit": 20,
	"client_url": "http://your_torrent_client_api",
	"display": "grid",
	"torrent_client": "qbittorrent",
	"torrent_client_username": "admin",
	"torrent_client_password": "admin",
	"download_dir": "/some/directory/",
	"nzbget_url": "http://your_nzb_server_url",
    "nzbget_username**: "***",
    "nzbget_password**: "***",
    "nzbget_port": 6789

}
  • indexer_manager (string)
    • indexer manager to search. jackett or prowlarr
  • jackett_apikey (string)
    • The api key provided by Jackett, found on the dashboard.
  • jackett_url (string)
  • jackett_indexer (string)
    • The jackett indexer you wish to use for searches.
  • prowlarr_apikey (string)
    • The api key provided by Prowlarr, found on the dashboard.
  • prowlarr_url (string)
  • prowlarr_indexer (string)
    • The prowlarr indexer you wish to use for searches.
  • description_length (int)
    • The default description length
  • exclude (string)
    • Words to exclude from your results seperated by a space.
  • results_limit (int)
    • Max number of lines to show.
  • client_url (string)
    • The url to your torrent client's API
  • display (string)
    • The display style of the results table. You can view available choices here
  • torrent_client (string)
    • Your torrent client. Valid options are: local, qbittorrent, transmission and deluge.
  • torrent_client_username (string)
    • Your torrent client's login username.
  • torrent_client_password
    • Your torrent client's login password. Note: Only Transmission accepts empty passwords.
  • download_dir
    • Where to save the torrent files when using "local" downloader.
  • nzbget_url (string)
    • url for nzbget server
  • nzbget_username (string)
    • nzbget username
  • nzbget_password (string)
    • nzbget pasword
  • nzbget_port (int)
    • nzbget port

Built with

  • requests
  • justlog
  • colorama
  • tabulate
  • transmission-clutch
  • deluge-client
  • python-qbittorrent

All available on Pypi.

License

This project is licensed under the MIT License

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

raincoat-prowlarr-0.2.1.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

raincoat_prowlarr-0.2.1-py2.py3-none-any.whl (11.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file raincoat-prowlarr-0.2.1.tar.gz.

File metadata

  • Download URL: raincoat-prowlarr-0.2.1.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.7

File hashes

Hashes for raincoat-prowlarr-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7e12821399a44c93b488d8074f873798dfa6daf9a83d0d3533cda08cb64178b4
MD5 784d3b32e7a6e565da1c48948703fd0d
BLAKE2b-256 a15bd25d2779f41a01edec4c1e2c2fe7827db218f6abd2586b178a061e9f7902

See more details on using hashes here.

File details

Details for the file raincoat_prowlarr-0.2.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for raincoat_prowlarr-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5aa4a743976307f3b04257fbc672a441df634e2b3a1936eb5a0e343280a5e53e
MD5 3c32919f925326b5e754c51345bbb33d
BLAKE2b-256 d10fc40086ecdd300e672dcfc6ce9fe8a2dcaeba82b1ed69900bdc8685bc67c6

See more details on using hashes here.

Supported by

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