Metadata-Version: 2.1
Name: raincoat-jackett
Version: 0.2
Summary: Raincoat is a tool to search torrents using Jackett and send them to your client.
Home-page: https://github.com/Gabisonfire/raincoat
Author: Gabisonfire
Author-email: gabisonfire@github.com
License: UNKNOWN
Description: # 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.x
        - Jackett and configured indexers
        - qBittorrent, Transmission or Deluge
        
        ### Usage
        
        `raincoat`
        
        #### 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'.
        
        #### 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_jackett_potato_feed",
        	"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"
        }
        ```
        
        - jackett_apikey (string)
          - The api key provided by Jackett, found on the dashboard.
        - jackett_url (string)
          - The jackett Potato feed url. (Not Torznab)
        - 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: 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.
        
        # 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
Keywords: transmission qbittorrent deluge jackett torrent
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Topic :: Communications :: File Sharing
Requires-Python: >=3.*
Description-Content-Type: text/markdown
