Skip to main content

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

Project description

Raincoat

Raincoat is a CLI tool to search torrents using Jackett's indexers and send them directly to your client.

Installation

pip install raincoat-jackett

Requirements

  • Python 3.6+
  • Jackett and configured indexers
  • qBittorrent, Transmission or Deluge (or use local download option)
  • 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 "Terms to search"

Parameters

  • -k, --key
    • Specify a Jackett 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'.
  • -i, --indexer
    • Change the indexer used for your search, in cases where you want to only search one site. Default is "all".
  • -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.

{
  "jackett_apikey": "",
  "jackett_url": "http://your_base_jackett_url",
  "jackett_indexer": "all",
  "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/"
}
  • 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.
  • 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.

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.1.0.tar.gz (10.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.1.0-py2.py3-none-any.whl (11.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: raincoat-prowlarr-0.1.0.tar.gz
  • Upload date:
  • Size: 10.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.1.0.tar.gz
Algorithm Hash digest
SHA256 11bbcae2cc8af9bfa363d5c4650777fb5426d2b38c18d92bcb2b22a509484f53
MD5 19b6b1abe01e4e9692197455f31adfc4
BLAKE2b-256 867a9588d877e4951f98ffe623d51054295faead5f906112b0f7ee034c06daa3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for raincoat_prowlarr-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 416f040ab98845dc277e1186b37be6a0be7409ffedcb8d9edc74e3274b7895f6
MD5 a172c64945d3615ddff5c7ea7b6ef298
BLAKE2b-256 df60fe0dc5c2e5b3f393adfe20ef98c149d9806de274e0ec945c4c6493daf699

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