# Raincoat
Raincoat is a CLI tool to search torrents using [Jackett](https://github.com/Jackett/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.
```json
{
"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)
- The base url for your jackett instance. (default: http://127.0.0.1:9117)
- 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](https://pypi.org/project/tabulate/)
- 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
Raw data
{
"_id": null,
"home_page": "https://github.com/Gabisonfire/raincoat",
"name": "raincoat-jackett",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.17",
"maintainer_email": null,
"keywords": "transmission qbittorrent deluge jackett torrent",
"author": "Gabisonfire",
"author_email": "gabisonfire@github.com",
"download_url": "https://files.pythonhosted.org/packages/70/68/dfbf98b33fcbe4d03e05e65b3e3ff0056822bb7ce8890f4879113eeaa2b5/raincoat-jackett-1.3.3.tar.gz",
"platform": null,
"description": "# Raincoat\n\nRaincoat is a CLI tool to search torrents using [Jackett](https://github.com/Jackett/Jackett)'s indexers and send them directly to your client.\n\n### Installation\n\n`pip install raincoat-jackett`\n\n### Requirements\n\n- Python 3.6+\n- Jackett and configured indexers\n- qBittorrent, Transmission or Deluge (or use local download option)\n- libtorrent if you use local downloader and magnet links.\n - Arch: `pacman -S libtorrent-rasterbar`\n - Ubuntu: `apt-get install python-libtorrent -y`\n - Fedora: `dnf install rb_libtorrent-python2`\n\n### Usage\n\n`raincoat \"Terms to search\"`\n\n#### Parameters\n\n- -k, --key\n - Specify a Jackett API key\n- -l, --length\n - Max number of characters displayed in the \"Description\" column.\n- -L, --limit\n - Limits the number of results displayed.\n- -c, --config\n - Specifies a different config path.\n- -s, --sort\n - Change the sorting criteria. Valid choices are: 'seeders', 'leechers', 'ratio', 'size' and 'description'. Default/not specified is 'seeders'.\n- -i, --indexer\n - Change the indexer used for your search, in cases where you want to only search one site. Default is \"all\".\n- -d, --download x\n - Grab the first x resultd and send to the client immediately. Defaults to 1.\n- -K, --insecure\n - Don't verify certificates \n- --local\n - Force use of \"local\" file download.\n- --list\n - Specify a file to load search terms from. One term per line.\n- --verbose\n - Extra verbose logging sent to log file.\n\n#### Configuration file\n\nUpon installation, a config file is created in your home directory. Before you can use Raincoat, you will need to modify it.\n\n```json\n{\n \"jackett_apikey\": \"\",\n \"jackett_url\": \"http://your_base_jackett_url\",\n \"jackett_indexer\": \"all\",\n \"description_length\": 100,\n \"exclude\": \"words to exclude\",\n \"results_limit\": 20,\n \"client_url\": \"http://your_torrent_client_api\",\n \"display\": \"grid\",\n \"torrent_client\": \"qbittorrent\",\n \"torrent_client_username\": \"admin\",\n \"torrent_client_password\": \"admin\",\n \"download_dir\": \"/some/directory/\"\n}\n```\n\n- jackett_apikey (string)\n - The api key provided by Jackett, found on the dashboard.\n- jackett_url (string)\n - The base url for your jackett instance. (default: http://127.0.0.1:9117)\n- jackett_indexer (string)\n - The jackett indexer you wish to use for searches.\n- description_length (int)\n - The default description length\n- exclude (string)\n - Words to exclude from your results seperated by a space.\n- results_limit (int)\n - Max number of lines to show.\n- client_url (string)\n - The url to your torrent client's API\n- display (string)\n - The display style of the results table. You can view available choices [here](https://pypi.org/project/tabulate/)\n- torrent_client (string)\n - Your torrent client. Valid options are: local, qbittorrent, transmission and deluge.\n- torrent_client_username (string)\n - Your torrent client's login username.\n- torrent_client_password\n - Your torrent client's login password. Note: Only Transmission accepts empty passwords.\n- download_dir\n - Where to save the torrent files when using \"local\" downloader.\n\n# Built with\n\n- requests\n- justlog\n- colorama\n- tabulate\n- transmission-clutch\n- deluge-client\n- python-qbittorrent\n\nAll available on Pypi.\n\n# License\n\nThis project is licensed under the MIT License",
"bugtrack_url": null,
"license": null,
"summary": "Raincoat is a tool to search torrents using Jackett and send them to your client.",
"version": "1.3.3",
"project_urls": {
"Homepage": "https://github.com/Gabisonfire/raincoat"
},
"split_keywords": [
"transmission",
"qbittorrent",
"deluge",
"jackett",
"torrent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7068dfbf98b33fcbe4d03e05e65b3e3ff0056822bb7ce8890f4879113eeaa2b5",
"md5": "84dbb156d60082c7e4e9504dba72d2f2",
"sha256": "705eedba2e2058cfcad46de1af541a7a6b94dca985ef6637d3273287976f6851"
},
"downloads": -1,
"filename": "raincoat-jackett-1.3.3.tar.gz",
"has_sig": false,
"md5_digest": "84dbb156d60082c7e4e9504dba72d2f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.17",
"size": 9274,
"upload_time": "2024-03-27T17:18:49",
"upload_time_iso_8601": "2024-03-27T17:18:49.244430Z",
"url": "https://files.pythonhosted.org/packages/70/68/dfbf98b33fcbe4d03e05e65b3e3ff0056822bb7ce8890f4879113eeaa2b5/raincoat-jackett-1.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 17:18:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Gabisonfire",
"github_project": "raincoat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "raincoat-jackett"
}
JSON
